cherry-doc：基于React的动态文档系统

caohaoyu 发布于2019-08-21 11:44 / 3222人阅读

摘要：概述是什么是一个基于的动态文档系统。区别于等文档工具，它是开发者边开发边生成文档网站，不会再有后期补充文档的烦恼。基于语法书写代码，可以通过标签运行里的代码预览效果。做到边开发边生成文档。

概述 cherry-doc 是什么？

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

特性

上手快，简单配置即可

基于md预览js代码效果

一键生成文档站点

无需数据库支持

支持自定义主题

支持两级目录

支持es6语法

支持hot-reload

组件渲染效果预览

^^^js
import React from "react";
export default class Comp extends React.Component {

handleClicked(e) {
    alert("hi cherry");
}

render() {
    return (
        
    )
}

}
^^^

GitHub地址： cherry-doc 详细文档地址（基于cherry-doc生成）：查看文档

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/87060.html

GitHub 值得收藏的前端项目[每月更新...]

摘要：也是一款优秀的响应式框架站点所使用的一套框架为微信服务量身设计的一套框架一组很小的，响应式的组件，你可以在网页的项目上到处使用一个可定制的文件，使浏览器呈现的所有元素，更一致和符合现代标准。 GitHub 值得收藏的前端项目整理与收集的一些比较优秀github项目，方便自己阅读，顺便分享出来，大家一起学习，本篇文章会持续更新，版权归原作者所有。欢迎github star与fork 预...

maxmin 2019-08-29 16:07 评论0 收藏0
react源码总览(翻译)

摘要：每次都信誓旦旦的给自己立下要好好学习源码的，结果都是因为某个地方卡住了，或是其他原因没看多少就放弃了。这次又给自己立个坚持看完源码。我看的源码版本是。本篇文章是官方文档里边的一篇文章的翻译，原文地址。每次都信誓旦旦的给自己立下要好好学习react源码的flag，结果都是因为某个地方卡住了，或是其他原因没看多少就放弃了。这次又给自己立个flag-坚持看完react源码。为了敦促自己，特...

Tikitoo 2019-08-23 13:58 评论0 收藏0
前端周刊第62期：学习学习再学习

摘要：腾讯前端技术大会和全球技术领导力峰会都于上周闭幕，我翻看了下讲稿，有价值的参考还是不少。腾讯前端大会下载腾讯前端大会是由腾讯主办，广邀国内外的前端大牛，有著名流行框架的作者知名前端书籍的作者工程化方面的权威等。 showImg(https://segmentfault.com/img/bVQk0r?w=757&h=427); 共 2462 字，读完需 4 分钟。腾讯前端技术大会（TFC...

tinylcy 2019-08-20 17:46 评论0 收藏0
前端每周清单第 29 期：Web 现状分析与优化策略、Vue 单元测试、Headless Chrom

摘要：前端每周清单第期现状分析与优化策略单元测试爬虫作者王下邀月熊编辑徐川前端每周清单专注前端领域内容，以对外文资料的搜集为主，帮助开发者了解一周前端热点分为新闻热点开发教程工程实践深度阅读开源项目巅峰人生等栏目。 showImg(https://segmentfault.com/img/remote/1460000011008022); 前端每周清单第 29 期：Web 现状分析与优化策略...

HackerShell 2019-08-21 12:05 评论0 收藏0