https://github.com/s33r/markdown-generator
Creates a static website from markdown files
https://github.com/s33r/markdown-generator
documentation markdown-to-html nodejs
Last synced: 5 months ago
JSON representation
Creates a static website from markdown files
- Host: GitHub
- URL: https://github.com/s33r/markdown-generator
- Owner: s33r
- License: mit
- Created: 2019-02-13T00:13:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-24T19:00:42.000Z (over 7 years ago)
- Last Synced: 2025-11-22T22:03:23.575Z (7 months ago)
- Topics: documentation, markdown-to-html, nodejs
- Language: JavaScript
- Homepage: https://s33r.github.io/markdown-generator/
- Size: 292 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/s33r/markdown-generator)
------------------------------------------------------------------------------------------------------------------------
Creates a static site from markdown files.
>This software is still in development and is not production ready.
[Github Repository](https://github.com/s33r/markdown-generator)
## Installation
```shell
npm install @aaron-cw/markdown-generator --save-dev
```
## Usage
Note: _Use absolute paths for all configuration options._
Usage:
```javascript
const markdownGenerator = require('@aaron-cw/markdown-generator');
const configuration = {
// The directory of markdown files to build
inputLocation: path.resolve(__dirname, '../documentation'),
// The directory where the resulting html files will be output.
outputLocation: path.resolve(__dirname, '../deploy/docs'),
// The title to use for the static site.
title: 'Default Documentation',
};
markdownGenerator(configuration);
```
The full set of options is detailed [here](./options.md).
## Markdown Format
markdown generator uses [GitHub Flavored Markdown](https://github.github.com/gfm/) and is parsed with [marked](https://github.com/markedjs/marked).
A cheatsheet is available: [https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet]
There is one non-standard extension to markdown. Markdown Generator has the ability to inclde code files inline.
To do so:
```markdown
`````javascript?./inline-example.js
``````
```
And it renders as:
```javascript?./inline-example.js
```