terminal.css/README.md

48 lines
1.2 KiB
Markdown
Raw Normal View History

2019-01-25 17:15:58 +01:00
# Terminal CSS
2019-01-28 03:37:25 +01:00
Modern and minimal CSS framework for terminal lovers.
2019-01-26 11:39:07 +01:00
Visit the website [terminalcss.xyz](https://terminalcss.xyz/)
2019-01-25 17:15:58 +01:00
2019-01-28 03:37:25 +01:00
## Project Goals
2019-01-25 17:15:58 +01:00
2019-01-28 04:01:49 +01:00
Terminal CSS has no overhead and is lightweight **(~3k gzip)**.
2019-01-28 03:37:25 +01:00
The source is written in **pure css** to be accessible for everybody and easy to contribute.
2019-01-25 17:15:58 +01:00
2019-01-28 03:37:25 +01:00
## Markdown ❤️ Terminal CSS
2019-01-25 17:15:58 +01:00
2019-01-28 03:37:25 +01:00
It's perfect for your *personal website*, *blog*, or *side project*.
2019-01-25 17:15:58 +01:00
2019-01-28 03:37:25 +01:00
## How to use
2019-01-25 17:15:58 +01:00
2019-01-28 03:37:25 +01:00
When using something like Webpack just install with `npm i terminal.css`.
2019-01-25 17:15:58 +01:00
```js
import 'terminal.css'
```
2019-10-07 09:34:44 +02:00
Terminal CSS is also available via [CDN](https://unpkg.com/terminal.css@0.7.1/dist/terminal.min.css)
2019-01-25 17:15:58 +01:00
```html
2019-10-07 09:34:44 +02:00
<link rel="stylesheet" href="https://unpkg.com/terminal.css@0.7.1/dist/terminal.min.css" />
2019-01-25 17:15:58 +01:00
```
2019-01-28 03:37:25 +01:00
## Themes
To create your own theme just open the dev-tools and edit the CSS Variables. Copy and paste it to your website. Done!
2019-01-25 17:15:58 +01:00
## Development
- `npm install`
- `npm run start`
2019-01-27 22:55:55 +01:00
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
2019-01-25 17:15:58 +01:00
## License
2019-01-26 11:39:07 +01:00
MIT © [Gioni06](https://github.com/Gioni06)