https://github.com/rumkin/drakkar
Markdown site generator with only one kill feature
https://github.com/rumkin/drakkar
javascript markdown site-generator
Last synced: 9 months ago
JSON representation
Markdown site generator with only one kill feature
- Host: GitHub
- URL: https://github.com/rumkin/drakkar
- Owner: rumkin
- Created: 2016-03-23T12:08:21.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-23T17:33:19.000Z (over 7 years ago)
- Last Synced: 2025-09-09T13:17:59.020Z (9 months ago)
- Topics: javascript, markdown, site-generator
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Drakkar
Drakkar is pretty simple markdown site generator with only one feature. This
feature is support of menu document named `_.md` which is visible on each
page as a sidebar.
## Installation
Install with npm
```
npm install drakkar -g
```
## Structure
Default site structure should contain `_.md` document in the root directory.
This file would be used as sidebar.
FS layout example:
```
.
|-- drakkar.js
|-- index.md
|-- license.md
|-- _.md
`-- sub
`-- doc.md
```
## Usage
Drakkar has two arguments. The first is sources directory (default is `.`) and the second is output directory (default is `www-docs`).
```
drakkar [options] [source]
-v,--verbose Verbose output
-d,--debug Debug
-o,--output Output directory. Default is `www-docs`.
```
If there is `drakkar.js` in sources dir then it will be used to modify drakkar
instance.
Modifier script example:
```javascript
module.exports = function() {
this.renderer.plugins.date = function(date) {
return new Date();
};
}
```
## License
MIT.