Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanqing/q
🍦 An opinionated CLI for creating lightweight, vanilla HTML/CSS websites
https://github.com/yuanqing/q
Last synced: 10 days ago
JSON representation
🍦 An opinionated CLI for creating lightweight, vanilla HTML/CSS websites
- Host: GitHub
- URL: https://github.com/yuanqing/q
- Owner: yuanqing
- License: mit
- Created: 2019-06-12T19:44:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-30T07:41:08.000Z (almost 4 years ago)
- Last Synced: 2024-10-13T06:21:31.461Z (27 days ago)
- Language: JavaScript
- Homepage:
- Size: 151 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @yuanqing/q [](https://www.npmjs.org/package/@yuanqing/q)
> An opinionated CLI for creating lightweight, vanilla HTML/CSS websites
## Features
- Leverage [Tachyons](https://github.com/tachyons-css/tachyons/) for CSS
- Minification and compression of HTML, CSS and images
- Watch and rebuild on changes
- Linting and auto-formatting
- Deploying via FTP
## Installation
```
$ npm install --global @yuanqing/q
```
## Usage
```
$ q --help
q
Commands:
q build [types..] Build HTML, CSS, images
q clean Delete the `build` directory and other artefacts
q fix [types..] Auto-format HTML and CSS
q ftp Upload the `build` directory
q lint [types..] Lint CSS
q serve Serve the `build` directory
q watch [types..] Watch and rebuild HTML, CSS and images on changes
Options:
--help Show help [boolean]
--version Show version number [boolean]
```
## Directory structure
- All implementation code is placed in the `src` directory.
- CSS files must match the glob pattern `src/css/**/*.css`. The entry CSS file is `src/css/style.css`.
- HTML files must match the glob pattern `src/**/*.html`.
- Images are placed in the `media` directory and must match the glob pattern `media/**/*.{gif,jpg,png}`.
- HTML, CSS, and images are output to the `build` directory
## License
[MIT](LICENSE.md)