Socket
Socket
Sign inDemoInstall

nightdocs

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

nightdocs

The nightdocs documentation site generation


Version published
Weekly downloads
6
increased by200%
Maintainers
1
Weekly downloads
 
Created
Source

nightdocs

A lightweight blazingly-fast markdown-powered static site generator for your next project.

Work in Progress!

A simple static site generator for your next project's documentation. Converts a folder of Markdown to static HTML that you can host on a web server.

Getting Started

Install with npm:

npm install --save-dev nightdocs

Then, write a toml config file like this:

[template]
project_name = "Sheep Counter Plus"

[directories]
# Path to docs (input) folder
docs = "./docs"
# Path to build (output) folder
output = "./__nightdocs"

Then execute:

node_modules/.bin/nightdocs --config path/to/config.toml

Contributing

Contributions are welcome! Simply fork this repository, make your changes, and submit a Pull Request (aka Merge Request).

All contributions must be declared to have the Mozilla Public License 2.0 (the same license that this repository is under).

License

The lantern build engine is licensed under the Mozilla Public License 2.0 (MPL-2.0). This license can be found in the LICENSE file in this repository, along with a link to an easy-to-read summary.

Keywords

FAQs

Package last updated on 17 Mar 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc