mkdocs学习笔记
文章平均质量分 89
AlwaysDayOne
这个作者很懒,什么都没留下…
展开
-
(七)mkdocs学习——其他技巧
部署技巧当我们修改好文档时,需要执行mkdocs gh-deploy命令才能将其部署到GitHub Page上。我们还可以采用CI持续集成工具在github上自动部署,即在根目录加上 .github/workflow目录,然后创建ci.yml文件,参考如下例子:name: ci on: push: branches: - master # 监测的分支jobs: deploy: runs-on: ubuntu-latest # 拉去虚拟环境镜像 step原创 2021-12-29 15:26:56 · 555 阅读 · 0 评论 -
(六)MkDocs学习——部署文档
部署文档 - MkDocs中文文档Deploying Your Docs - MkDocsGitHub Pages如果您在GitHub上托管项目的源代码,则可以轻松使用GitHub Pages来托管项目的文档。GitHub页面有两种基本类型:Project Pages站点和User and Organization Pages站点。它们几乎完全相同但有一些重要的区别,在部署时需要不同的工作流程。Project Pages项目页面站点更简单,因为站点文件被部署到项目存储库中的分支(默认情况下为“.原创 2021-12-29 15:25:22 · 1488 阅读 · 0 评论 -
(五)MkDocs学习——配置文件
简介始终使用名为mkdocs.yml的位于项目目录中的YAML文件来进行设置。(当然也可以将mkdocs.yml放置其他目录,需要在build时做命令调整,使用-f/--config-file 选项)此配置文件必须包含site_name与site_url设置。 所有其他设置都是可选项。项目信息site_name这是一个必需的设置,应该是一个字符串,用作项目文档的主标题。 例如:site_name: Marshmallow Generator渲染主题时,此设置将作为site_name上下文变原创 2021-12-29 15:24:38 · 2151 阅读 · 0 评论 -
(四)MkDocs学习——自定义主题
如果您想对现有主题进行一些调整,则无需从头开始创建自己的主题。对于只需要一些CSS和(或)JavaScript的小调整,您可以使用docs_dir。但是,对于更复杂的自定义(包括覆盖模板),您需要使用主题的custom_dir设置。使用docs_dirextra_css和extra_javascript配置选项可用于对现有主题进行调整和自定义。要使用它们,您只需要在[文档目录]中包含CSS或JavaScript文件。例如,要更改文档中标题的颜色,请创建一个名为extra.css的文件,并将其放在文档M原创 2021-12-29 15:23:43 · 1797 阅读 · 1 评论 -
(三)MkDocs学习——配置主题
https://mkdocs.zimoapps.com/user-guide/styling-your-docs/Choosing Your Theme - MkDocsMkDocs包括一些内置主题以及各种第三方主题,所有这些都可以使用额外的CSS或JavaScript轻松定制,或者覆盖主题的custom_dir。 您也可以为你的文档从头开始创建自己的自定义主题。要使用MkDocs中包含的主题,只需将其添加到您的mkdocs.yml配置文件中。theme: readthedocs使用下面的 .原创 2021-12-29 15:20:23 · 2830 阅读 · 0 评论 -
(二)MkDocs学习笔记——撰写文档
撰写文档 - MkDocs 中文文档Writing Your Docs - MkDocs如何撰写 markdown 源码并安排目录结构.目录结构文档是普通的 Markdown 文件, 放到项目目录里. 通常目录以 docs 命名, 和 mkdocs.yml 配置文件一起放置于项目的顶级目录中.最简单的项目目录结构可能是这样的:mkdocs.ymldocs/ index.md默认项目主页是 index. Markdown 源码文件的后缀可以是以下任意一种: markdown, m.原创 2021-12-29 15:16:56 · 1767 阅读 · 0 评论 -
(一)MkDocs 学习——快速开始
mkdocs学习笔记原创 2021-12-29 15:14:36 · 2285 阅读 · 2 评论