将mkdocs markdown改为标题“目录”的正确方法是什么？

将mkdocs markdown改为标题“目录”的正确方法是在markdown文件中使用特定的语法。可以通过在标题前加上“[toc]”来生成一个包含目录的标签。

示例：

# [toc]标题一
## 子标题一
## 子标题二
### 子子标题一
### 子子标题二
标题二

在上面的示例中，"[toc]"标记告诉mkdocs生成一个包含目录的标签。

相关·内容

我们是如何搭建 giantpandacv.com 的

网站整体结构依据 mkdocs.yml 配置，所有 Markdown 文件分类后放到 docs 目录下。...将 site 目录中所有文件拷贝到你的 Apache 或者 Nginx 服务器网站目录中即可正常访问网站内容。注：不需要 mysql，php 等环境支持。...修改方法：在图片下方加换行 ? ? 数字标题序号未按正常序列进行排列 ? 修正方法一：直接加粗 ?...在这里插入图片描述修改方法二：修改为4级标题（这样改会修改正文右边的目录结构，所以我一般在上面个方法不生效的时候用） ? 在这里插入图片描述公式未正常解析 ?...在这里插入图片描述修改方法：检查文件名前后是否含有多余空格 ? ---- 欢迎关注GiantPandaCV, 在这里你将看到独家的深度学习分享，坚持原创，每天分享我们学习到的新鲜知识。

7122 0

用Python写静态博客

MkDocs 使用Markdown的项目文档。概观 MkDocs是一个快速，简单且彻头彻尾的华丽静态站点生成器，旨在构建项目文档。...文档源文件以Markdown编写，并使用单个YAML配置文件进行配置。主持任何地方 MkDocs构建完全静态的HTML网站，您可以在GitHub页面，Amazon S3或您选择的任何其他地方托管。...docs/index.md在您选择的文本编辑器中打开文档，将初始标题更改为MkLorum，并保存更改。您的浏览器将自动重新加载，您应该立即看到更新的文档。现在尝试编辑配置文件：mkdocs.yml。...添加页面现在在文档中添加第二页： curl 'https://jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md 由于我们的文档站点将包含一些导航标题...GitHub项目页面和Amazon S3可能是很好的托管选项，具体取决于您的需求。将整个site目录的内容上传到您托管网站的任何地方，然后您就完成了。

1.6K2 0

dedecms网站迁移时记得将安装目录放空附迁移的正确方法

这段时间在赶一些新项目，我们建站一般都在本地服务器搭建起来，测试得差不多了才传到网上，这样对蜘蛛也相对友好一些，要不然改来改去变化太大给搜索引擎的第一印象很不好。...以dedecms为例，用ftp将本地建好的文件传到网站上，重新生成文档出现了很多错误，相对路径要改，最重要的是系统配置参数的安装目录要放空，否则会提示错误。 ? 　　...dedecms网站迁移的正确方法：　　1.首先登录织梦的后台，进入到“系统》数据库备份/还原”栏目。 ? 　　...2.将备份好的数据文件传过去，备份文件一般是在织梦程序根目录下的data文件夹下的backupdata文件夹　　3.将模板文件传过去　　4.进入到“系统-》数据库备份/还原-》右上角数据还原-》左下角开始还原数据...” 　　5.设置相应的系统配置文件，特别是开始所说的将安装目录设为空　　6.生成html文件，全站更新。

2.3K3 0

Nebula Graph｜如何打造多版本文档中心

为什么需要文档打造出一款产品后，我们需要一份文档来回答以下问题：设计这款产品的原因是什么（Why）这是一款什么样的产品（What）产品面向的用户是谁（Who）在哪些场景下可以用这款产品（Where...MkDocs MkDocs 是一个快速、简单、美观的开源静态网站生成器，用于构建项目文档。文档源文件为 Markdown 格式，配置写在 YAML 文件中。.../nebula-docs-cn' # 添加正确的路径后文档右上角会出现编辑按钮，点击可直接跳转到编辑文件的页面 edit_uri: 'edit/master/docs-2.0/' # 指定包含文档源Markdown...[如何打造多版本文档中心] 设置导航栏 Markdown 文件在导航栏的显示顺序可以通过 mkdocs.yml 文件中的 nav 字段配置。...将非断链但暂时不适合发布的文件设置在 /mkdocs.yml 中的 exclude 字段，这样能起到隐藏效果，详细说明参考注释。修改前一个版本的前言，建议用户升级新版本。参考示例。

7614 0

Python 文档生成器 mkdocs

mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器，中文文档地址使用 mkdocs 我们可以用 md 编写自己的文档，而且可以免费部署到 GitHub 。...image.png vi mkdocs.yml 把site_name 的 my docs 改为中文我的文档 ?.../writing-your-docs/#configure-pages-and-navigation 改为 site_name: 我的文档 nav: - 主页: 'index.md' - 关于: 'about.md...目录中....然后将公钥上传到GitHub 配置。

1.6K2 0

使用 Python 30分钟教你快速搭建一个博客

这是非常好的习惯，它使得知识得以提炼，转输出为输入，在提升自己的同时，还能利用互联网易传播的特性，将知识分享给每一个热爱学习的人。这是值得每个程序员，投入时间和精力去坚持做下去的事。...博客既然是自己的一个知识宝库，那么索引将变得极为重要。通过自己的探索，小明发现了一个能够很好地满足这个需求的 Python 框架 Sphinx。...实现的大体的思路如下： Markdown：书写文档 Pandoc：格式转化 Sphinx：生成网页 GitHub：托管项目 ReadtheDocs：发布网页接下来，就来看看到底是如何实现的？...在mkdocs根目录下，添加文件.gitignore（聪明的你，肯定知道这是什么），内容如下 build/ .idea/ *.pyc 接下来，在你的GitHub上新建一个仓库。...然后把mkdocs这个目录下的所有文件都提交上去。步骤很简单，这里就不细讲。 06 发布上线 ---- 托管完成后，我们要发布它，让别人可以访问。

1.1K2 0

DevOps: Mkdocs 静态站点生成器简介及实践

1.简介 MkDocs是一个基于Python的静态站点生成器，它可以将Markdown格式的文档转换为漂亮的静态网站。MkDocs提供了一种简单而灵活的方式来创建文档，并支持多种主题和插件。 2....mkdocs new命令初始化MkDocs项目，该命令会生成一个包含配置文件和目录结构的项目：在项目根目录，命令行中使用mkdocs new来初始化文档。.../docs/index.md 执行后在项目中生成docs目录及mkdocs.yml配置文件 2.3 编写文档在docs目录下修改index.md，并新建其他Markdown格式的文档，如下图： 2.4...# 默认主题 nav: - 首页: index.md - 安装方法: install.md - 使用方法: usage.md - 模块列表: - 项目管理: modules.../project.md - 接口管理: modules/interface.md - 作者说明: author.md 所有文件的引用都是相对与docs目录，支持菜单及引用子目录文件，如“

2491 0

几款文档框架：Mkdocs、Sphinx、Teadocs、docsify

幸运的是有了 mkdocs，不仅能轻松制作类似 Scrapy 帮助文档的文档项目，而且支持 markdown 语法。...使用MkDocs 安装 MkDocs pip install mkdocs 创建项目执行下面命令就在当前目录下，生成一个 testdocs 文件夹，就是创建的文档项目 mkdocs new testdocs...cd命令进入文件夹，查看结构 mkdocs.yml 为配置文件 docs 文件夹中为文档文件目录，文件使用 markdown 编写文档预览进入创建的文档项目目录，执行 mkdocs serve...如果 index.md 和 README.md 同时存在，将忽略 README.md 非 markdown 文件 markdown 文件，即扩展名为 md 的文件，会被转化为 html。...部署](/deploy) 符号介绍语法完全使用markdown里的无序列表定义语法，但是要特别注意以下几点： [] 里的内容表示菜单的标题，如果不写[]则代表这个菜单没有链接仅作为一个菜单名称

1.8K2 1

使用mkdocs发布文档

Mkdocs是一款基于Python的静态站点生成工具，可以用于生成美观的文档站点。它支持多种主题和插件，使用简单，适合用于生成各种文档站点。本文将介绍如何使用Mkdocs生成文档站点。...（2）进入Mkdocs工程目录： cd （3）使用以下命令启动本地服务器： mkdocs serve 在本地浏览器中打开http://localhost:8000，就可以查看新建的...编辑Mkdocs文档 Mkdocs使用Markdown语法编写文档，可以使用任何Markdown编辑器进行编辑。...编辑Mkdocs文档的步骤如下：（1）在Mkdocs工程目录下，找到docs文件夹，该文件夹存放Mkdocs文档。（2）在docs文件夹中，创建Markdown文件，用于编写Mkdocs文档。...具体步骤如下：（1）使用以下命令生成静态网站： mkdocs build 该命令将生成一个名为site的文件夹，其中包含了Mkdocs生成的所有静态网站文件。

9250 0

用python手把手教你搭建一个个人主页

web框架，适用于更复杂的应用，使用起来也不是什么难事，也是首先安装 pip install django 其代码也flask大差不差，就不贴代码了，感兴趣的朋友去django官网了解一下，因为不是本文的重点...MkDocs MkDocs专注于创建项目文档，但也可用于创建简单的博客。特点：使用Markdown编写内容。简单易用，适合文档项目。有多种主题可供选择。...在项目的post目录下使用markdown来写作使用 hero -s 启动本地server进行预览使用 hero -d 来打包一个静态网站想一想，实际上这个就是我们需要的一个最最基本的静态网站生成器的功能...1、第一步，创建几个文件和文件夹，目录结构如下 2、这里面最主要的实现其实是converter这个模块，他负责去遍历posts目录下的markdown文件，将其渲染为 html 并保存为文件方到 output...，也就是他将项目根目录给暴露出来了。

1.4K3 0

谈一谈|MkDocs介绍及应用

1 什么是MkDocs MkDocs---markdown项目文档工具，是一个用来创建项目文档的快速、简单、完美的静态站点生成器，文档源码使用Markdown来撰写，用一个yml文件作为配置文档。...它是基于Google的Material Design 指南搭建的。 3 安装因为mkdocs是基于python对markdown的文档生成器，安装mkdocs之前得先安装python。...其路径根据安装方法不同位置不同，pip安装的是在python安装目录下的scripts下。最后以管理员身份打开cmd，输入mkdocs没报错就是安装成功了。.../(添加次级目录) - Home: index.md /(主页) - Blog: mkdocs介绍.md /(其他页面...) 在次级目录下还可以创建目录。

1.1K2 0

用 Material for MkDocs 来生成专业的技术文档

由于GitHub和Markdown格式的普及，很多时候我们可以用markdown来简便地写出技术文档，并且通过GitHub Pages等工具快速地进行技术文档的部署。...另外一种学习配置的方式是直接查看上面提到的开源项目源码根目录下的mkdocs.yml文件，复制这个文件过去，就能得到类似的布局效果。...2.2 使用 mkdocs-material 的使用命令比较简单，概括来说就是三板斧： mkdocs new .：在当前目录生成docs目录和mkdocs.yml 配置文件 mkdocs serve：...因而核心要做的事情其实是：写markdown 格式的文档文件修改配置文件mkdocs.yml 在mkdocs serve 运行的过程中，更新完 mkdocs.yml配置文件后，文档生成效果实时更新。...具体来说，假设你已经创建了一个Git 仓库，需要做下面的事情：将mkdocs.yml 和docs 目录提交到Git仓库增加GitHub Action 配置文件.github/workflows/ci.yml

5672 0

使用mkdocs及docs-material自动编译生成静态页面并自动提交GitLab Pages

又被一个问题折磨疯了，然后又在一个莫名其妙的地方解决了？？？ MkDocs 是一个快速、简单、快捷可用的静态网站生成工具，文档使用 Markdown 书写，并仅需一个 YAML 配置文件。...本人使用过 Hexo和 Docsify，直到我发现了 MkDocs 以及它的绝配主题 mkdocs-material ，Mkdocs 的目录下仅需一个配置文件，然后就是完全的 MakeDown 文件即可...，初始化的 Mkdocs 项目文件夹下仅有一个 docs 文件夹和 mkdocs.yaml 配置文件，及其简单，接下来就可以根据需要进行文档撰写，左侧的树形导航可以在 yaml 文件夹中配置，下面给一个多级菜单的配置样例...具体方法请查阅超链接部分的文档。...pages 中的 mkdocs build 为 mkdocs 的生成命令，会将页面渲染为静态网站并放在 site 文件夹下，之后 mv site public 将生成好的网站转移到 public

2.5K2 0

pymkdocs：用户生成和管理 MkDocs 文档

pymkdocs 是一个基于 Python 的库，旨在帮助用户生成和管理 MkDocs 文档。 MkDocs 是一个用于创建项目文档的静态站点生成器，使用 Markdown 作为文档格式。...本文将深入分析 pymkdocs 模块的应用，提供相关的 Python 代码示例，并探讨其在实际项目中的应用场景。...删除文档如果需要删除某个文档，可以使用以下方法： # 删除文档 project.remove_document('about.md') 生成文档网站在完成文档的创建和管理后，我们可以使用 MkDocs...以下是如何使用命令行生成网站的步骤： 1. 在项目目录下，运行以下命令： mkdocs build 2. 生成的静态文件将保存在 site 目录中。 3....教师可以通过编写 Markdown 文档，轻松创建课程内容，并生成静态网站供学生访问。总结 pymkdocs 是一个强大的工具，可以帮助用户高效地创建和管理 MkDocs 文档。

761 0

快速、简单、美观：构建现代化文档的工具链

它使用 Markdown 编写文档源文件，并通过一个 YAML 配置文件进行配置。MkDocs 设计易于使用，并可通过第三方主题、插件和 Markdown 扩展来定制功能。...以下是该项目的关键特性和核心优势：从 Markdown 文件中构建静态 HTML 文件。使用插件和 Markdown 扩展增强 MkDocs 功能。...可以使用内置主题、第三方主题或创建自己的主题。将您的文档发布到任何可以提供静态文件服务的地方。...简洁易用：使用 Markdown 编写文档，并通过简单直观的目录结构组织内容。无需复杂配置，只需要专注于编写内容本身。...快速生成：利用预渲染技术，在每次部署时将页面转换为静态 HTML 文件，从而实现快速加载和响应式体验。多平台适配：无论是在电脑上还是移动设备上浏览您的文档网站都能得到良好呈现。

4113 0

辛辛苦苦敲一天，不如python写两行：一文带你见识办公自动化黑魔法

毕过业的同学，哪一个没被论文的格式熬到圆圈发黑。 ? 信python的有福了。有了markdown助力，你可以轻松写出官方一样规整的文档。 ? 没错儿，说的就是这个工具。mkdocs。安装起来很简单。...电脑上安装有python后，使用pip安装即可： pip install mkdocs 我们把细节放大，看看其有哪些优秀的设计。 ? 导航栏，带下拉框，支持多级菜单。你需要做的，仅仅是目录有层级。...系统自带的基于sphinx的全文搜索引擎，可以让你瞬间直达目录文档。 ? 最重要的是，使用mkdocs可以把markdown编译为html静态网页。...mkdocs build 而使用github page提供的功能，我们可以将这个文档免费发布到网上。最重要的是，mkdocs使用python开发，源代码开放，任何人可以手动修剪，以期更美好。...下面我们通过例子，学习python操作word的方法。场景就以制作超多个请柬为例。请柬的word模板如下： ? 首先准备好excel文件，存放被邀请人的列表信息。使用python读入数组。 ?

7012 0

Vuepress文章转pdf

前言 vuepress原始文件是markdown文件，生成的web页面时html，如果想保存为pdf有2类方法。...版本说明： "vuepress": "^1.9.7" https://www.npmjs.com/及github上搜索的工具/插件 #1. md文件转pdf #vuepress2pdf 不能使用 https...docs目录下所有的文章合并为一个pdf文件样式比较乱，有些vuepress特有的语法不支持 #2. html转pdf 样式可以与网页显示一致 #mr-pdf推荐支持docusaurus, vuepress..., mkdocs https://github.com/kohheepeace/mr-pdf 注意：本地开发url要使用http://127.0.0.1:端口号标题不支持中文, 报'xxx' 不是内部或外部命令...，也不是可运行的程序速度会慢一些，转换一个网页大约需要 10s 修改了文件名以及导出时去掉评论 npx mr-pdf --initialDocURLs="http://127.0.0.1:8080/3

3K6 0

个人免费博客花式搭建指南 Online Editor 篇

前言近些年，随着 Markdown 的蓬勃发展，越来越多地支持 Markdown 语法的在线编辑器和托管服务提供商出现。...事实上，如果将 Jekylll 换成 Mkdocs，会发现能够通过编译并在线预览成功，但是 PDF 生成还是会有问题。...所以最好的就是在 Github 建一个空的项目，将空的项目导入到 Read the Docs 中即可。 ...由于本站是采用 Jekyll 静态生成器的，所有只需将 _posts 目录下的 Markdown 文件全部拖拽到这里导入即可完成 Gitbook 的转换。...（采用 CC BY-NC-SA 4.0 许可协议进行授权）本文标题：《个人免费博客花式搭建指南 Online Editor 篇》本文链接：https://lisz.me/tech/webmaster

9612 0

MdBook | GitBook的替代者

1、前言前面，我们已经介绍过很多的文档构建工具，比如Docsify、MkDocs、Nikola、Pelican等等。今天我们来介绍一款号称是GitBook替代者的文档构件工具，它就是MdBook。...MdBook是一款使用Rust开发的文档构建工具，它特别轻量，不依赖开发环境，仅仅一个可执行文件就能完成文档构建。而且构建出的文档网站具备代高亮、本地搜索、markdown渲染等功能。...我们向src中增加一个目录，然后向其中添加一个md文件，启动mdbook的开发服务器查看效果。 2.4、预览文档命令：.\mdbook.exe serve ....2.5、自定义侧边栏 mdbook的侧边栏是在项目根目录下的SUMMARY.md中定义的，我们只需要将我们自己开发的文档在SUMMARY.md中进行配置，即可实现侧边栏导航。...3、小结经过简单的使用体验，我们可以发现mdbook构建文档是非常的简单，但是它也存在一些问题。不支持中文搜索。不支根据文档标题自动生成侧边目录。代码块行间距太小。不支持提示块。

6.7K1 1

博客生成静态站点工具 Top 20

MkDocs 是一个简单易用的静态网站生成器，基于 Markdown 文档构建漂亮的 HTML 文档页面。 MkDocs具有以下特点：采用Markdown格式编写文档，易于编写和维护。...部署简单，可以将生成的HTML静态页面部署到任何Web服务器上。使用 MkDocs，您可以快速创建漂亮的文档页面，非常适合技术写作、软件文档、项目文档等。...Eleventy 自称是 Jekyll 的替代品，旨在以更简单的方法来制作更快的静态网站。你可以参照它的 GitHub和官网来了解更多的细节。 13.Pelican star 数 10K+。...Middleman 是一个用 Ruby 编写的静态站点生成器，它可以将 Markdown、ERB 模板和 YAML 配置文件转换为静态 HTML 文件。...Sphinx 是一个用于创建技术文档的工具，可以将文本文件（如reStructuredText、Markdown等）转换成HTML、PDF、EPUB等格式。

3.8K2 1

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云