v-no

中文版

v-no is a lightweight static site renderer / generator for Markdown, and also a pure static single page application powered by Vue.js at the same time.

Demo and documentation：https://akrisrn.github.io/v-no-doc/?conf=en

(It is a work in progress, and English edition is just an empty shell for now. I will translate it when Chinese edition has done.)

Main features

• Switchable multiple config group.
• Embeddable snippets and templates.
• Executable inline scripts.
• Dynamic imports custom scripts / styles.
• A ton of API for inline / custom scripts.
• Bi-directional links between Markdown files.
• Extended Markdown syntax.
• Added mark syntax.
• Nestable tags syntax.
• Highlightable site-wide search.
• Dark / zen mode.

Who will be interested in?

• Hope Markdown could program page content.
• Hope to increase Markdown reuse, and create links between them.

Who will not be interested in?

• Want to use custom themes, or change layout.
• ...

Related repos

• v-no-script
• v-no-doc
• v-no-doc-script
• v-no-page-component
• Templates:
  • v-no-template
  • v-no-hash-template
  • v-no-script-template

Project setup

Install dependencies:

yarn install

Run a hot reload server for development:

yarn run serve

Build minimized files for production:

yarn run build
# build in modern mode
yarn run build-modern

Unit test：

yarn run serve
yarn run test:install-browser
yarn run test:unit

API

Generate by typedoc: https://akrisrn.github.io/v-no/

中文 API 文档（转换自 vno.d.ts）：https://akrisrn.github.io/v-no-doc/-/#/zh/api/