# docsify

**Repository Path**: musefulizi/docsify

## Basic Information

- **Project Name**: docsify
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-22
- **Last Updated**: 2022-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
 * @Author: 吕程
 * @Date: 2021-04-21 10:47:32
 * @LastEditors: 吕程
 * @LastEditTime: 2021-04-30 15:56:41
 * @FilePath: \nd-docs\README.md
-->

## 快速开始

### 下载

git 地址： https://gitee.com/musefulizi/docsify

```bash
git clone git@gitee.com:musefulizi/docsify.git nd-docs
```

### 安装插件

推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档。

```bash
npm i docsify-cli -g
```

### 启动项目

通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000 。

```bash
docsify serve nd-docs
```

### 编辑文档

1. 在编辑器里面编辑后提交到 git
1. 点击页面上方的:memo: [编辑此页](https://gitee.com/musefulizi/docsify/blob/master/README.md), 在线编辑

---

## 使用技术

### docsify

docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。文档地址：https://docsify.js.org/#/zh-cn/

### Markdown Preview Enhanced

Markdown Preview Enhanced 是一款为 Atom 以及 Visual Studio Code 编辑器编写的超级强大的 Markdown 插件。
这款插件意在让你拥有飘逸的 Markdown 写作体验。文档地址：https://www.bookstack.cn/read/mpe/zh-cn-_sidebar.md

### EMOJI

提供 emoji 解析的，能将类似 &#58;100&#58; 解析成 :100:。参考地址：https://www.webfx.com/tools/emoji-cheat-sheet/