https://github.com/rsms/mkweb

simple static website generator
https://github.com/rsms/mkweb

Last synced: over 1 year ago
JSON representation

simple static website generator

• Host: GitHub
• URL: https://github.com/rsms/mkweb
• Owner: rsms
• License: isc
• Created: 2021-07-31T23:26:01.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-09-25T00:35:21.000Z (over 3 years ago)
• Last Synced: 2025-03-15T21:17:05.850Z (over 1 year ago)
• Language: JavaScript
• Size: 424 KB
• Stars: 62
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# mkweb

mkweb is a simple static website generator for NodeJS

Features:

- Simple and fast

- Templates (currently hard coded to "template.html")

- Markdown with code-syntax highlighting

- Front matter (for both markdown and html pages)

- Incremental updates ("watch the filesystem" kind of thing)

- Livereload local webserver

Usage:

1. make a directory and put some html, css and/or md files in there

2. install mkweb from NPM: `npm i rsms-mkweb`

3. run mkweb in that directory: `./node_modules/.bin/mkweb`

4. your website can be found in `_site`

See `mkweb -h` for customization options and extra features

TODO:

- Some way to configure & customize it

- Ignoring files (maybe from .gitignore + custom list)