Auctor is a simple Node.js based static site generator that uses Markdown or EJS JavaScript templates for content and EJS JavaScript templates for layout templates.
Pronunciation: awkTOHR
- Version 1.1.1 contains an update for EJS with breaking changes to includes:
<% include file.ejs %>
changes to<%- include('file.ejs'); %>
- Version 1.2.0 contains critical fixes and breaking changes to the
serve
module. - Version 1.4.0 updates all dependencies to latest versions, including a few breaking changes.
- Version 1.5.x contains cleaner console log output, and fixes to the path separator character.
- [ ] Create an index as content is generated.
- [ ] Duplicate page output detection (based on index).
- [ ] Add automated sitemap generation (based on index).
- [ ] Add Robots.txt support, with integrated sitemap support.
- [ ] Add SASS support.
- [ ] Add minify support.
- [ ] Add Code of Conduct.
- marked Markdown parser.
- ejs JavaScript template engine.
- front-matter for Jekyll-style front-matter YML parsing.
- fs-extra for filesystem access.
- glob for pattern matching.
Auctor expects the following structure by convention:
- _layout
- default.ejs
- (Any other EJS layout files)
- assets
- (Any CSS, JS, image files)
- content
- (Any EJS, MD, or directories)
npm install # install required NPM packages
npm run build # run the auctor build process
npm run serve # serve the generated HTML pages (locally)
npm login
npm publish
- Auctor Documentation
- Auctor Source Code
- Auctor NPM Package
- This project loosely follows Conventional Commits
This project was influenced by the following: