cherry-doc
markdown to doc
Last updated 4 years ago by kele .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install cherry-doc 
SYNC missed versions from official npm registry.

Build Status

cherry

image

概述

cherry-doc 是什么?

cherry是一个基于React的动态文档系统。区别于hexo等md文档工具,它是开发者边开发边生成文档网站,不会再有后期补充文档的烦恼。基于markdown语法书写js代码,可以通过code标签运行code里的js代码预览效果。 做到边开发边生成文档。

特性

  • 上手快,简单配置即可
  • 基于md预览js代码效果
  • 一键生成文档站点
  • 无需数据库支持
  • 支持自定义主题
  • 支持两级目录
  • 支持es6语法
  • 支持hot-reload

快速开始

step 1

在项目根目录添加 cherry.config.js

module.exports = {
    title: 'cherry-doc 使用说明', // 文档标题
    root: './src', // md 存放目录
    ext: '.md', // md 后缀名
    category: [
    ],
    server: {
        port: 8000,  // server port
        middleware: []
    },
}

step2

安装 cherry-doc

npm i --save-dev cherry-doc

step3

在cherry.config.js之前设置root目录里新建 test.md

---
page: test
rank: 0
---

## 我是测试页面

step4

在package.json 添加 dev 命令

"scripts": {
    "dev": "cherry dev",
  },

step5

执行

npm run dev

浏览器输入 localhost:8000 即可看到效果

详细文档以及效果预览

文档地址

Current Tags

  • 1.0.23                                ...           latest (3 years ago)

22 Versions

  • 1.0.23                                ...           3 years ago
  • 1.0.22                                ...           3 years ago
  • 1.0.21                                ...           3 years ago
  • 1.0.20                                ...           3 years ago
  • 1.0.19                                ...           3 years ago
  • 1.0.18                                ...           3 years ago
  • 1.0.17                                ...           3 years ago
  • 1.0.16                                ...           3 years ago
  • 1.0.15                                ...           3 years ago
  • 1.0.13                                ...           3 years ago
  • 1.0.12                                ...           3 years ago
  • 1.0.11                                ...           4 years ago
  • 1.0.10                                ...           4 years ago
  • 1.0.9                                ...           4 years ago
  • 1.0.8                                ...           4 years ago
  • 1.0.7                                ...           4 years ago
  • 1.0.6                                ...           4 years ago
  • 1.0.5                                ...           4 years ago
  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (30)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |