https://github.com/pimbrouwers/npm-static-site-generator
NPM Static Site Generator
https://github.com/pimbrouwers/npm-static-site-generator
javascript npm static-site-generator
Last synced: about 1 month ago
JSON representation
NPM Static Site Generator
- Host: GitHub
- URL: https://github.com/pimbrouwers/npm-static-site-generator
- Owner: pimbrouwers
- License: mit
- Created: 2017-02-02T13:34:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-23T01:11:33.000Z (over 7 years ago)
- Last Synced: 2025-02-02T01:44:37.917Z (3 months ago)
- Topics: javascript, npm, static-site-generator
- Language: JavaScript
- Homepage:
- Size: 311 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NPM Static Site Generator
Leveraging the power of NPM scripts, the tool facilitates generating static html site using:
- Handlebars - backed by JSON data
- LESS
- RequireJs (setup as a KnockoutJS solution, but can easily be configured)
## Install
Install generator as **git submodule**:
- `mkdir mycoolsite`
- `cd mycoolsite`
- `git submodule add https://github.com/pimbrouwers/NpmStaticSiteGenerator.git tools`
- `npm run --prefix tools init`
You're now left with a `www_src` dir, which houses your website code. And a `www_dist` dir which houses your deployable code.
## Develop
When you're ready to begin development, simply run: `npm run --prefix tools develop`. This launches `watch` which will recompile the `www_dist` directory in response to any changes made in the `www_src` directory. It will also spin up an instance of `http-server` to make the compiled results viewable @ `127.0.0.1:8080`.
## Compile
When you're ready to deploy your code, simply run: `npm run --prefix tools compile` to populate your `www_dist` directory.
## API
```
"clean": "rimraf ../www_dist/*",
"init": "npm install && node scripts/install.js && npm run devlib:js",
"copy:img": "ncp ../www_src/img ../www_dist/img",
"devlib:js": "ncp node_modules/requirejs/require.js ../www_src/require.js & ncp node_modules/requirejs/bin/r.js ../www_src/r.js & ncp node_modules/knockout/build/output/knockout-latest.js ../www_src/knockout.js & ncp node_modules/jquery/dist/jquery.min.js ../www_src/jquery.js & ncp node_modules/requirejs-text/text.js ../www_src/text.js",
"build:js": "node ../www_src/r.js -o ../www_src/require.build.js optimize=none",
"compile:js": "node ../www_src/r.js -o ../www_src/require.build.js",
"build:less": "lessc --clean-css ../www_src/less/app.less ../www_dist/app.css",
"build:pages": "node scripts/build-pages.js",
"develop": "http-server ../www_dist/ & watch --wait=1 'npm run copy:img & npm run build:js & npm run build:pages & npm run build:less' ../www_src/",
"compile": "npm run clean && npm run copy:img & npm run compile:js & npm run build:pages & npm run build:less"
```
Built with ♥ by [Pim Brouwers](https://github.com/pimbrouwers) in Toronto, ON. Licensed under [MIT](https://github.com/pimbrouwers/NpmStaticSiteGenerator/blob/master/LICENSE).