auctor

1.3.0 • Public • Published

auctor

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

Release Notes

  • 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.

Roadmap

  • [ ] Duplicate page detection (output to same file location).
  • [ ] Create an index as content generated (could be used by duplicate page detection algorithm).
  • [ ] Add automated sitemap generation for all generated pages.
  • [ ] Add Robots.txt support, with integrated sitemap support.
  • [ ] Add SASS support.
  • [ ] Add minify support.
  • [ ] Add Code of Conduct

Dependencies

Getting started

To keep it simple, Auctor expects the following structure by convention:

  • _includes
    • (Any EJS includes)
  • _layout
    • default.ejs
    • (Any other EJS layout files)
  • assets
    • (Any CSS, JS, image files)
  • content
    • (Any EJS, MD, or directories)

Basic NPM Commands

npm install   # install required NPM packages
npm run build # run the auctor build process
npm run serve # serve the generated HTML pages (locally)

NPM Package Update Commands

npm login
npm publish

References

This project was heavily influenced by the following:

Readme

Keywords

none

Package Sidebar

Install

npm i auctor

Weekly Downloads

2

Version

1.3.0

License

MIT

Unpacked Size

7.29 kB

Total Files

4

Last publish

Collaborators

  • nathanlaan