dokiv
A document generator with vue and markdown
Last updated a year ago by wemlion .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install dokiv 
SYNC missed versions from official npm registry.

dokiv

Static site generator with Vue and Markdown.

This project is inspired by nuxt.js.

Usage

# as global module
npm install -g dokiv
# as local dependency
npm install --save dokiv

Watch mode with live-reloading:

dokiv -w
# or
dokiv --watch

Generate static files:

dokiv

Configuration

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 history
  • rootDir: root directory of docs
  • output: dest directory
  • documents: glob to markdown pages, array or string
  • postcss: postcss configuration
    • postcss.entry: string, path to CSS entry
    • postcss.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

Directory Structure

Suppose your rootDir is docs, following subdirs are required.

  • docs/static: static contents
  • docs/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

Markdown Rule

---
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!'
---

# My record

lorem ipsum....

Note:

  • layout and route are required.
  • title or meta.title is required.
  • more info about meta, click here.

Here is the markdown demo.

Click here to get an example.

Reference

En

中文

Current Tags

  • 2.3.1                                ...           latest (a year ago)

38 Versions

  • 2.3.1                                ...           a year ago
  • 2.3.0                                ...           a year ago
  • 2.2.5                                ...           2 years ago
  • 2.2.4                                ...           2 years ago
  • 2.2.3                                ...           2 years ago
  • 2.2.2                                ...           2 years ago
  • 2.2.1                                ...           2 years ago
  • 2.2.0                                ...           2 years ago
  • 2.1.0 [deprecated]           ...           2 years ago
  • 2.0.12                                ...           2 years ago
  • 2.0.11                                ...           2 years ago
  • 2.0.10                                ...           2 years ago
  • 2.0.9                                ...           2 years ago
  • 2.0.8                                ...           2 years ago
  • 2.0.7                                ...           2 years ago
  • 2.0.6                                ...           2 years ago
  • 2.0.5                                ...           2 years ago
  • 2.0.4                                ...           2 years ago
  • 2.0.3                                ...           2 years ago
  • 2.0.2                                ...           2 years ago
  • 2.0.1                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 2.0.0-alpha0.1                                ...           2 years ago
  • 2.0.0-alpha                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.6                                ...           2 years ago
  • 1.1.5                                ...           2 years ago
  • 1.1.4                                ...           2 years ago
  • 1.1.3                                ...           2 years ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.1.0-alpha                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 1.0.0-beta                                ...           2 years ago
  • 1.0.0-alpha                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 40
Last Day 0
Last Week 39
Last Month 2
Dependencies (41)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |