程序问答   发布时间:2022-06-01  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了从 Markdown 生成技术文档网站的工具大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。

如何解决从 Markdown 生成技术文档网站的工具?

开发过程中遇到从 Markdown 生成技术文档网站的工具的问题如何解决?下面主要结合日常开发的经验,给出你关于从 Markdown 生成技术文档网站的工具的解决方法建议,希望对你解决从 Markdown 生成技术文档网站的工具有所启发或帮助;

我正在寻找一种工具来生成一个静态网站来托管一些内部文档,例如开发技巧、我们使用的工具、一些简单的教程等。团队,而不是非正式的。

我敢肯定,市面上有很多工具,实际上要尝试选择一种工具是非常困难的。 rmarkdown / blogdown 看起来很酷,但我以前从未听说过。 Github Markdown Render 看起来很有趣(但不是静态的),当然有数百种用于博客的工具,还有很多可以通过代码生成网站(Sphinx、Doxygen)。

更具体的要求:

  • 尽可能简单,最好在一个命令行中创建网站文件。我们不需要完整的 wordpress 设置。
  • 渲染效果很好,尤其是代码。例如,我喜欢 Github 渲染。
  • 可以在文件之间导航。
  • 得到很好的支持/庞大的社区。​​li>
  • 如果可能,可针对外观进行自定义,并在布局等方面给予更多控制。不过,这不是优先事项。
  • 足够通用,如果有一天我决定需要更好的控制,我可以更换工具。

大家有什么推荐的吗?

PS:我选择 markdown 是因为它似乎是最常见的,而且我已经知道/使用它,但我愿意休息或做任何事情。

解决方法

docsify 可能会满足您的需求。

从 Markdown 生成技术文档网站的工具

从 Markdown 生成技术文档网站的工具

尽可能简单,最好在一个命令行中创建网站文件。

一个 docsify 站点是在一个命令中创建的。

docsify init ./docs

可以在文件之间导航。

有一个侧边栏可以在文件之间导航。

得到很好的支持/庞大的社区。​​p>

这是一个 17.3k 的项目。现在有 160 位贡献者(2021 年 4 月 16 日)。

很好的渲染,尤其是代码。

如果可能,可自定义外观和 a 以更好地控制布局。

它是可定制的。您可以在 Awesome Docsify 上找到由 docsify 创建的网站和 docsify 的主题。

足够通用,如果有一天我决定需要更好的控制,我可以更换工具。

别担心。许多工具都支持 Markdown。您可以随时更改工具。

大佬总结

以上是大佬教程为你收集整理的从 Markdown 生成技术文档网站的工具全部内容,希望文章能够帮你解决从 Markdown 生成技术文档网站的工具所遇到的程序开发问题。

如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。
标签: