index.md 808 B

介绍

什么是Teadocs?

Teadocs 是一款能够帮你快速构建html文档的工具,它基于nodejs编写,并使用markdown来编写文档内容。

Teadocs 提供内置的搜索技术,除了编写好你引以为豪的内容以外,你无需关注的任何额外的技术问题。

你可以使用它来编写开源书籍、API文档学习、笔记、学习心得、甚至可以用来写博客。

原理

Teadocs 会自动根据你编写的markdown文档自动生成html文档,并且生成的html文档具备可复用、可移植等特性,可以部署在任何你喜欢的地方。

贡献

github地址:https://github.com/lisniuse/teadocs

如果你想贡献代码,我们建议你先fork阅读Teadocs的源码,然后push你的idea。