V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member Sign In
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
This topic created in 1301 days ago, the information mentioned may be changed or developed.
我想写教程，类似 runoob 、w3school 那种，左边是列表，右边是内容。
只想用 markdown 写教程，不想改代码。
20 replies • 2022-10-08 13:50:45 +08:00
 |
1
Hansah Oct 7, 2022
你又要好看，又不想改代码，只能找找好看的主题了
|
 |
2
malagebidi Oct 7, 2022
docusaurus 的打印效果比较好，这个我对比过
|
 |
3
kongkx Oct 7, 2022 via iPhone
好看的定义是？ 有参照对象？ 要不在 docusaurus 的 showcase 里面找个喜欢的，扒一下主题代码？
|
 |
4
lavard Oct 7, 2022  1
最近比较火的 Astro ? 性能爆炸 但是比较新, 社区模板主题啥的还比较少
|
|
5
lavard Oct 7, 2022
或者 VitePress 也是不错的，Vue 周边生态都是用 VitePress 搭的，挺好看的。比如 Vue 官网，Vite, Pinia, Vitest.
如果 docusaurus 支持 Vite 就更好了，webpack 在内容多的时候热更新的速度还是让人非常不满意 |
 |
6
LindsayZhou Oct 7, 2022
https://squidfunk.github.io/mkdocs-material/
我看到很多 Python 开源库的文档都是用的这个。 |
|
8
lavard Oct 7, 2022 1
@Hsins 那肯定是高啊。 因为采用 Islands Architecture （孤岛架构）， 几乎没有 JS 代码， 而且支持各大前端框架，Vue ，React, Angular , Solid ... 。
我用 lighthouse 测 ， 清一色 100 分，离谱的很， 我本来博客也是 docusaurus 搭的，也尝试过 VitePres ， 很喜欢 Vite 的开发体验， 但是 VitePress 很多方案社区还没有，比如 i18 国际化，在线沙盒..etc, 然后就一直找到了 Astro ，支持任意前端框架 + Vite 。（ Astro 团队 之前开发过 SnowPack , 干不过 Vite 所以用 Vite 了） |
 |
9
laravel OP 这次用 vuepress 试试吧
|
|
10
laravel OP vitepress 的 hello world 真干净，剧情开头很吸引人。
https://raw.githubusercontent.com/tennessine/v2ex-images/main/QQ20221007-184156%402x.png |
 |
11
zhoujinjing09 Oct 7, 2022
VitePress 或者 mkdocs
docusaurus 审美落后了，但是 VitePress 很多功能现在还没有 |
|
12
laravel OP 1
哎，我还是美化下 docusaurus 吧，感觉都差不多，没必要换一个，我以前用 docusaurus
|
 |
13
yufeng0681 Oct 7, 2022
obsidian ，写完发布到 obsidian 的网站上（收费）
或者找开源的发布成 html ，自己弄个网站加载起来 |
 |
14
azraeljack Oct 7, 2022
之前公司的文档库是用 dumi 搭的，感觉还行
|
 |
15
dayeye2006199 Oct 8, 2022
教程的核心难道不是里面的内容么。。
排版啥的干净方便查询不就可以了。。 |
 |
16
loading Oct 8, 2022
|
 |
18
Envov Oct 8, 2022
如果只有 markdown 的话，可以自己写脚本扫一下文件目录，生成网站，样式啥的不是随便弄吗
|
 |
19
Deteriorator Oct 8, 2022
我用的是 rst 文档， 用 sphinx 生成的文档也方便
|
 |
20
ada87 Oct 8, 2022 via Android
mkdocs
|
Select Language