https://github.com/unplugstudio/pug-static-site
A static-site boilerplate with Pug, SCSS, and ES6 support
https://github.com/unplugstudio/pug-static-site
Last synced: 10 months ago
JSON representation
A static-site boilerplate with Pug, SCSS, and ES6 support
- Host: GitHub
- URL: https://github.com/unplugstudio/pug-static-site
- Owner: unplugstudio
- License: mit
- Created: 2020-04-20T21:23:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T23:44:48.000Z (over 3 years ago)
- Last Synced: 2025-01-20T23:49:13.063Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 2.62 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Static Starter
A static site boilerplate. Includes Webpack + SCSS + ES6 + Pug.
## Getting started
Clone the repository, and delete the `.git` folder. Then:
```bash
npm install
git init
git add .
git commit -m "Initial commit based on static-starter"
```
## Resulting output
For each `.pug` file in the `templates` directory Webpack will generate an `.html` file with the same name. It will respect folders as well. Files that start with an underscore, like `_example.pug` will NOT generate an HTML file (useful for partial and layout templates).
Keep in mind that if you add new `.pug` files you'll need to restart Webpack for them to be generated.
### Development mode
Run `npm start` to start the Webpack Dev Server. This will serve your files on `localhost:8080` with hot reload on save.
### Production mode
Run `npm run build` to generate assets optimized for production in the `/dist` folder.