可以试试:

antvis/gatsby-theme-antv?

github.com图标

蚂蚁金服数据可视化系列官网的 Gatsby 主题,背靠巨大的 Gatsby 社区,使用 antd 组件 UI 加持,封装了统一简单的配置,内建页头页尾布局,静态预渲染,PWA,主题配置,国际化,markdown 文档,灵活的菜单生成,文章锚点,可编辑的在线演示,首页各类 Banner/特性/案例的展示组件。

目前还在光速迭代中,11-22 AntV 系列新官网正式上线,欢迎关注!AntV 官网改造 · Issue #18 · antvis/antvis.github.io


2019-11-22 更新:使用这个主题打造的 AntV 系列新官网发布上线了,我们发布了 G2Plot 图表,Graphin 图分析套件,ChartCube 图表魔方 三个新产品,以及改造了之前的所有产品的首页,均由 gatsby-theme-antv 进行搭建。

AntV | 蚂蚁数据可视化?

antv.vision图标dxqing:知源 · 致远 - AntV 11.22 年度发布?

zhuanlan.zhihu.com图标


我个人还是最喜欢gitbook

你只需要把md传到GitHub即可

就针对支持github这一项来说,秒杀语雀等

更别说支持自定义域名了

个人不喜欢gatsby或者vuepress等,虽然我曾经是gatsby的组织成员,但是那时候是因为我对graphql感兴趣而已::&>_&


那你一定是需要这个了,Vue官方的文档网站生成器

介绍 | VuePress


这个我给题主推荐一下,其实下面已经有人说了,是vuepress

VuePress 中文文档 | VuePress 中文网?

www.vuepress.cn图标

不过我推荐的理由是,我最近就用这个给公司搭建了产品手册文档。体会了一下其方便性。

关键是,本人是产品设计师的角色,并没有很多coding基础,但是按照教程来,一步一步,很快也完成了,后续更新也是得心应手。

用vuepress的好处总结一下有如下几个

  1. 通过markdown本地创建和维护文档,方便更新和迁移。
  2. 本地文档可方便地通过github等代码管理版本管理工具来管理。
  3. 可以生成html的静态文档,方便发布。
  4. vuepress原生的模板颜值也不错,响应式的布局,还支持搜索。

文档截图

需要具备的一些知识

  1. 一些基本的命令行操作(推荐使用mac系统或者linux)
  2. 一些写代码的软体(推荐vscode,不要用记事本啊朋友)
  3. 了解一些git的知识和操作(为了方便代码管理和备份)

基本就是这样了,欢迎交流

yinyu.name


试试我写的 rcpress https://github.com/YvesCoding/rcpress

模仿的vuepress 不过是基于的react

主题是使用ant design搭建的


vue-press


vuepress或docsify。

我自己用docsify写的,基本没有学习成本,会写md就一顿狂写就完事了。


不知道你有没有发现

其他答主的回答截图里 使用了很多 chrome 插件.....

求人不如求己 去搜索 chrome 插件 网站技术栈 ... 关键词

以后遇到喜欢的网站 就无需再问


除了上述答主说的之外,我推一个

docsify?

docsify.js.org

简单易用好上手,样式我觉得也很不错


具体问题具体分析,先弄清你要写啥,自然能找到数不清的解决方案。

要是只写写字,画画表格,markdown-it及其周边现成的东西就足够用了。

输出组件和对应代码,可以自定义loader载入,用vue-loader当组件载入一遍,再用raw-loader输出一遍源码,再找个代码高亮的高亮下代码,最后再把源码和组件包裹成一个组件。

如果需要在线编辑,看下各个线上IDE的REST API文档,弄个按钮集成到上面写的组件就成。

如果需要在页面上调整参数,直接预览,可以用一些现成的框架,比如storybook的knobs https://github.com/storybookjs/storybook/tree/next/addons/knobs


推荐阅读:
相关文章