美文网首页
文档书写 - 最香的还是mkdocs

文档书写 - 最香的还是mkdocs

作者: DeanWang | 来源:发表于2023-02-26 10:02 被阅读0次

github.io 主题

themes
minimal 左侧有不动的侧边栏
slate 黑白主题,还可以
time-machine 上下滑动的时候有吸顶
architect 样式还可以
cayman 整体感觉最好
还是太麻烦了

gitbook安装

npm install -g gitbook-cli
# 新建目录,进入目录后执行
gitbook init
# 组织子目录结构,然后编辑markdown文件
# summary.md 是目录文档, 编辑完成后生成html
gitbook build [书籍路径] [输出路径]
# 如果像生成PDF
gitbook pdf ./ book.pdf

各种问题, 无法顺利使用

mkdocs

getting-started

pip install mkdocs
# 直接进入项目目录,创建mkdocs.yml以及docs子目录即可
mkdocs build
# 生成静态文件在site目录下

mkdocs.yml 可参考官方文档,示例:

site_name: XXXX
site_url: http://xxxx.com
nav:
    - xxx: index.md
    - 介绍: intro.md
    - 关于: about.md

theme: readthedocs

相关文章

  • Python 文档生成器 mkdocs

    mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器,中文文档地址 使用 mkdocs...

  • mkdocs如何支持中文搜索

    mkdocs是一个很方便的文档网站生成器,文档使用Markdown格式来编写,luat的wiki就是用mkdocs...

  • 文档发布工具mkdocs

    mkdocs是Python的一个对 Markdown 友好的文档生成器。,小巧精美。 MkDocs is a fa...

  • 文档神器mkdocs

    简介 官网:mkdoc.org mkdocs 基于Python,迅速生成基于Markdown和Yaml配置文件生成...

  • mkdocs注意事项

    文档目录配置 自带主题修改 修改mkdocs自带的主题 复制mkdocs的主题文件夹至自定义主题文件夹custom...

  • 使用 mkdocs 创建文档

    什么是 mkdocs mkdocs是一个用来生成文档的工具,它可以用来将一组 markdown 格式的文件转换成 ...

  • 使用MkDocs 管理博客

    需求 MarkDown 文本 文档结构化,方便组织 搜索整理 shell 编辑 随时随地编辑 MkDocs 优点 ...

  • Python3搭建mkdocs本地文档服务

    python版本:Python3.6 在mkdocs官网下载mkdocs:https://www.mkdocs.o...

  • MkDocs 文档生成逻辑浅析

    Markdown 和 MkDocs 简介 Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强,因此有...

  • Mkdocs 项目文档简易制作

    markdown 写的文档,在项目组内外分享时不能要求读者也将就着读markdown,最好还是读网页的友好形式 —...

网友评论

      本文标题:文档书写 - 最香的还是mkdocs

      本文链接:https://www.haomeiwen.com/subject/zxmohdtx.html