mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 12:10:04 +08:00

History

qingwei.li 1bf7b23d33 Add chiniese doc		2016-11-26 17:24:32 +08:00
..
404.html	Add chiniese doc	2016-11-26 17:24:32 +08:00
lib	Remove plugins	2016-11-26 14:09:06 +08:00
README.md	Add chiniese doc	2016-11-26 17:24:32 +08:00
themes	Remove plugins	2016-11-26 14:09:06 +08:00
zh-cn.md	Add chiniese doc	2016-11-26 17:24:32 +08:00

README.md

docsify

A magical documentation site generator.

Features

Easy and lightweight
Custom themes
No build

Quick Start

Create a project

First create a project, then create a docs folder

mkdir my-project && cd my-project
mkdir docs && cd docs

Create entry file

Create a 404.html file

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></script>
</html>

Create README.md as the main page

# Title

## balabala

Deploy!

Push and open the GitHub Pages feature

CLI

Easy to setup and preivew a docs.

Install

npm i docsify-cli -g

Setup

Setup a boilerplate docs

docsify init docs

Preview

Preview and serve your docs using

docsify serve docs

Themes

Currently available vue.css and buble.css

<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">

Multiple pages

If you need other pages, directly create the markdown file, such as guide.md is /guide.

Code in 404.html

<nav>
  <a href="/">En</a>
  <a href="/zh-cn">中文</a>
</nav>

GitHub Corner

Modify your 404.html

<script src="//unpkg.com/docsify" data-repo="your/repo"></script>