chiaweilee / vue-markdown-docs

Build your docs website with Markdown file (*.md) quickly.

Home Page:https://chiaweilee.github.io/vue-markdown-docs/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Vue Markdown Docs

What it is?

  • create your docs website with Markdown only
  • automatic convert *.md to Vue component
  • automatic section link bind
  • full i18n support by vue-i18n, vue-i18n-loader and vue-i18n-filter

base on @chiaweilee/vue-markdown-loader

Demo and Docs

see https://chiaweilee.github.io/vue-markdown-docs/

DO NOT REFRESH/RELOAD on this demo

How to use?

fork, clone, download..

write *.md, refactor core, ... any you like

HTML5 History Mode

vue-router's HTML5 History Mode used.

!example-server-configurations

Install

npm install
npm run inspect

Dev

npm run dev

Prod

npm run build
npm run dist

About

Build your docs website with Markdown file (*.md) quickly.

https://chiaweilee.github.io/vue-markdown-docs/


Languages

Language:CSS 67.5%Language:JavaScript 18.4%Language:Vue 12.7%Language:HTML 1.4%