一款微文档生成系统-tinydoc

背景

在学习中,了解问题的本质,把知识管理起来是件不容的事情。出于复杂简单化的原则,花时间开发了这个小系统。

我的使用场景

1、搭建班子

2、团队代码规范文档

tinydoc介绍

tinydoc是一款微文档生成系统,用Markdown格式编写,可以快速的写出文档,基于Node.js编译生成一个完整的HTML静态网站。

功能介绍

1、支持部署和直接打开HTML访问(不需要部署)。

2、支持文档目录结构。

3、支持移动端。

使用方法

左侧导航

编辑项目根目录sideNav.md编辑左侧导航配置文件,模块化分类,对应文件目录编写Markdown文件即可,左侧导航目录统一放在documents目录下。

网址导航

编辑项目根目录nav.md编辑菜单导航配置文件,对应文件目录编写Markdown文件即可,导航目录统一放在nav目录下。

安装

npm install

生成静态

npm run build

项目地址

项目地址

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值