A document generator with vue and markdown
npm install dokivStatic site generator with Vue and Markdown.
This project is inspired by nuxt.js.
``bash`as global module
npm install -g dokivas local dependency
npm install --save dokiv
Watch mode with live-reloading:
`bash`
dokiv -wor
dokiv --watch
Generate static files:
`bash`
dokiv
A dokiv.yml must be found under the root of your project.
You can take a look at ./dokiv.yml.
* highlight: default code highlight theme, highlight.js or prism routerMode
* : vue router mode, eitherhash or historyrootDir
* : root directory of docsoutput
* : dest directorydocuments
* : glob to markdown pages, array or stringpostcss
* : postcss configurationpostcss.entry
* : string, path to CSS entrypostcss.minify
* : boolean, whether to minify output (always true in watch mode)postcss.sourcemap
* : boolean, whether to use inline sourcemap (always true in watch mode)postcss.plugins
* : array of PostCSS plugins (defaults to postcss-import and postcss-cssnext)externals
* : additional css/javascript urls
Suppose your rootDir is docs, following subdirs are required.
- docs/static: static contentsdocs/plugins
- : JavaScript modules, each can exposes an install method with constructor Vue injected, and a routing method where router(VueRouter instance) injected.docs/layouts
- : .vue files(single file Vue components) for various types of layouts
`
---
layout: default
route: /post/2017/12/record
title: 'A record for Nov 12 2017'specify highlight theme for this file
highlight: 'prism'
meta:
title: 'A record for Nov 12 2017'
titleTemplate: '%s - Yay!'
---
lorem ipsum....
`
Note:
* layout and route are required.title
* or meta.title is required.meta`, click here.
* more info about
Here is the markdown demo.
Click here to get an example.