MkDocs的使用

最新推荐文章于 2024-08-16 13:30:48 发布
最新推荐文章于 2024-08-16 13:30:48 发布
阅读量323 收藏
点赞数
文章标签： 操作系统 python
原文链接：https://my.oschina.net/u/3465063/blog/892302
版权
一 、安装

  1. MkDocs安装

    MkDocs安装过程略过，参考官网。

    windows 7或windows server 2008下安装需要注意的是python的3.X版本需要操作系统打sp1补丁，建议使用python 2.7

  2. 插件pymdown-extensions安装

    pip install pymdown-extensions

    详细使用参考这里

二 、修改配置

MkDocs项目目录下有名为mkdocs.yml的配置文件，可设置的具体信息参考官网，使用PyYaml语法

三 、添加md文件

MkDocs项目目录下有名为docs的目录，在其中存放md文件即可

三 、运行(参考官网)

转载于:https://my.oschina.net/u/3465063/blog/892302

chuhanning9279
关注
Python 文档生成器 mkdocs
sushengbuhuo的博客
06-16 1162
mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器，中文文档地址 使用 mkdocs 我们可以用 md 编写自己的文档，而且可以免费部署到 GitHub 。 安装 pip install mkdocs 新建文档 λ mkdocs.exe new mydoc INFO - Creating project directory: mydoc INFO - ...
mkdocs-mermaid2-plugin:适用于mkdocs的美人鱼图插件
05-10
mkdocs-mermaid2-plugin 一个插件，可将文本图形描述呈现为图形（流程图，顺序图，饼图等）。 这是来自的叉子，该不再维护。 它提供了扩展的文档以及新功能。 用法 一般原则 如何编写美人鱼图 向Mermaid引擎添加...
mkdocs 使用说明
pengwupeng2008的专栏
11-24 803
mkdocs使用说明
为技术项目量身定做的文档工具MkDocs
最新发布
wbsu2004的博客
08-16 6654
MkDocs 是一个静态网站生成器，专门用于创建项目文档。
MkDocs 快速入门
MichaelAn的博客
02-13 886
MkDocs 快速入门 2021-11-03 本文选自 《了不起的Markdown》，作者：毕小烦 MkDocs 是一个用 Python 开发的静态站点生成器工具，它可以非常简单快速的创建项目文档。MkDocs 的文档源码使用 Markdown 编写，配置文件使用 YAML 编写，可以一键编译成静态站点。 很多开...
so easy！从头教你用mkdocs构建个人博客系统~
水木子的博客
04-22 8350
本文主要介绍如何使用mkdocs构建个人网站。 文章目录1. mkdocs介绍2. mkdocs安装3. mkdocs简单使用3.1 入门使用3.2 Markdown语法3.3 YAML语法3.4 添加页面3.5 更改外观更改图标更改主题4. 部署站点4.1 GitHub项目页面个人页面4.2 云服务器5. 高级知识5.1 mkdocs主题目录与site目录5.2 修改默认样式5.3 自定义主题参考资料 1. mkdocs介绍 MkDocs is a fast, simple and downright
mkdocs入门
weixin_46151516的博客
07-24 1184
请注意，搜索结果包括搜索词在站点上的每次出现，并直接链接到搜索词出现的页面部分。Mkspeed自带了一个内置的dev-server，可以让你在处理文档的时候预览文档。如果你正在使用其他的源代码控制工具，你需要查看它的文档，了解如何忽略特定的目录。您刚刚构建的文档站点只使用静态文件，因此您可以从几乎任何地方托管它。由于我们的文档站点将包含一些导航标题，您可能需要编辑配置文件，并通过添加。您的浏览器将自动重新加载，您应该立即看到更新的文档。保存您的更改，您将看到正在使用的ReadTheory主题。
obsidian-mkdocs:使用MkDocs发布黑曜石笔记
04-05
使用MkDocs发布黑曜石笔记（模板） 如何开始？ 使用创建一个新的github存储库 在此步骤中，为您的公共注释存储库命名。 默认情况下，您的笔记将被发布，您的公共笔记将在 从模板创建存储库时，您只需要复制main...
mkdocs使用mkdocs serve 可以生成HTTPS链接吗
04-23
您可以使用mkdocs serve命令生成一个本地服务器并创建一个自签名的SSL证书，以生成HTTPS链接。您只需要在命令中添加--cert-file和--key-file选项，然后将它们指向您的SSL证书和密钥文件即可。例如，使用以下命令生成...
mkdocs-meta-descriptions-plugin:from在每个MkDocs页面的第一段中生成一个元描述
04-04
要使用`mkdocs-meta-descriptions-plugin`，首先确保已经安装了MkDocs。如果还没有安装，可以通过Python的包管理器pip进行安装： ```bash pip install mkdocs ``` 接下来，安装元描述插件： ```bash pip install ...
foam-mkdocs-template:使用mkdocs mkdocs-material mkdocs-roamlinks-plugin
05-19
该模板使用 ， ， 和许多mkdocs插件。 演示版 国内访问 用法：部署到github页面 分叉此存储库 将您的文档添加到docs ， docs/index.md是网站的主页 打开mkdocs.yml ，将site_name修改为您的网站名称，此文件是网站...
mkdocs-material-extensions:MkDocs Material 的 Markdown 扩展资源
05-29
MkDocs 材料扩展 Markdown 扩展资源 安装 pip install mkdocs-material-extensions 内联 SVG 图标 MkDocs Material 提供了大量来自 Material、FontAwesome 和 Octicons 的图标，但它是通过将 SVG 图标内联到源中来实现的。 目前没有简单的方法访问这些图标并将它们任意插入到 Markdown 内容中。 用户必须自己包含图标字体并使用 HTML 来完成。 该模块允许您使用 PyMdown Extensions 的扩展，以使用简单的:emoji-syntax:轻松插入 MkDocs Material 的 SVG 资产。 这是通过创建我们自己的和。 自定义索引提供了 Emoji 扩展 Twemoji 索引的修改版本。 除了自定义索引，您还必须指定关联的自定义生成器。 这将找到合适的图标并将其作
【详细】使用MkDocs搭建个人博客网站
weixin_45079659的博客
09-29 1362
自己开发博客网站，自定义网站
MkDocs
MichaelAn的博客
02-13 809
MkDocs Markdown 项目文档工具. 本文档翻译自官网mkdocs. 本文档托管于 Github. 概述 MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档. MkDocs 仍处于开发阶段....
2.快速上手MkDocs
qq_38641599的博客
07-10 237
如果想要编辑网站主页（我们知道主页文件是index.html），则应编辑index.md。不用修改网页代码，每个网页都来自用户的md文档，修改md文档即可。每次使用 MkDocs 首先进入 python 虚拟环境。在 mkdocs.yml 中配置网站主题，启动插件、功能。
mkdocs 生成帮助文档
weixin_33708432的博客
10-29 1058
简介 MkDocs 可以同时编译多个markdown文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。 MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。 官方快速开始 https://squidfunk.github.io/mkdocs-material/getting-started/...
1.介绍MkDocs
qq_38641599的博客
07-10 426
MkDocs 是一个简单且快速的静态网站生成器，专门用于项目文档。它使用Markdown文件作为内容源，基于Python构建，易于配置和使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值