Mkdocs文档生成

最新推荐文章于 2024-05-10 11:47:50 发布
最新推荐文章于 2024-05-10 11:47:50 发布
阅读量284 收藏
点赞数
文章标签： markdown
原文链接：http://www.cnblogs.com/boot/p/9307355.html
版权

【前置-软件安装】

https://www.mkdocs.org/#installing-mkdocs

【生成docs文档】

https://www.mkdocs.org/

在存放docs的目录下运行：

$curl 'jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md

则会在docs下生成一个新的about.md，在配置文件mkdocs.yml对pages配置便可得到一个新导航页面

 

转载于:https://www.cnblogs.com/boot/p/9307355.html

weixin_30326741
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MkDocs项目文档生成器(一)
一路向东
08-31 1万+
简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介类别：项目文档生成器，生成静态站点，管理MarkD
mkdocs-with-pdf 0.9.3的安装使用
谢绝留言与私信
10-13 1078
本来想将目录下的多个.md分别转成多个pdf文件.看到 mkdocs-with-pdf插件, 试试.最后发现, 只能将所有的.md都转成一个pdf, 不是我想要的效果.刚开始使用时, 各种报错. 用了一上午, 将mkdocs-with-pdf的使用问题解决了.虽然不是我要的效果, 但是初步安装使用 mkdocs-with-pdf时遇到了问题, 将解决过程记录一下.
文档发布工具mkdocs
weixin_33916256的博客
06-27 378
mkdocs是Python的一个对 Markdown 友好的文档生成器。，小巧精美。 MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation...
mkdocs
最新发布
u013595395的博客
05-10 146
1.安装mkdocs和material主题。
mkdocs-pdf-export-plugin:MkDocs插件可将内容页面导出为PDF文件
05-04
MkDocs PDF导出插件 MkDocs插件可将内容页面导出为PDF文件 pdf-export插件将使用将MkDocs存储库中的所有降价页面导出为PDF文件。 导出的文档支持大多数其他PDF导出所缺少的许多高级功能，例如PDF索引和对支持。 要求 此软件包需要MkDocs 1.0或更高版本（0.17也可以） Python 3.4 3.5以上 WeasyPrint取决于需要单独安装的cairo，Pango和GDK-PixBuf。 请仔细按照您平台的安装说明进行操作： 可能需要明确支持您的mkdocs主题。 到目前为止，唯一受支持的主题是 。 通用版本只会生成PDF文件，并将下载链接放入<link>标记中。 如果要添加新主题，请参阅获取更多信息。 安装 用pip安装软件包： pip install mkdocs-pdf-export-plugin 在您的mkdocs.yml启用插件
mkdocs-with-pdf：从MkDocs存储库生成单个PDF文件
02-05
PDF为MkDocs生成插件 此插件将从您的MkDocs存储库生成一个PDF文件。 该插件的灵感来自。 产品特点 PDF中的封面和目录 在标题（h1-h3）上自动编号。 下移子页面标题级别。 使用 。 样品 要求 此软件包需要MkDocs 1.0版或更高版本（0.17也可以） Python 3.6或更高版本 WeasyPrint取决于需要单独安装的cairo，Pango和GDK-PixBuf。 请仔细按照您平台的安装说明进行操作： 如何使用 安装 用pip安装软件包： pip install mkdocs-with-pdf 在您的mkdocs.yml启用插件： plugins :
gradle-mkdocs-plugin：Mkdocs文档生成和发布插件
02-04
`gradle-mkdocs-plugin` 可以帮助你将生成的MkDocs文档直接发布到GitHub Pages，使得你的项目文档可以轻松地分享和访问。只需在Gradle配置中指定目标分支和目录，插件就会自动处理发布过程。 **MkDocs与MkDocs ...
mkapi：MkDocs的文档生成工具
02-04
MkApi插件生成用于Python代码API文档。 MkApi支持两种类型的文档字符串：和 。 MkApi的功能有： 类型注释：如果您编写函数，例如def func(x: int) -> str:则无需再次在Parameters，Returns或Yields部分中写入类型...
ArkDoc:基于 Mkdocs 的 ArkScript Lite 文档生成器
05-31
它是一个基于 Mkdocs 的 arkscript Lite文档生成器，用 ruby​​ 编写。 依赖关系 Python >= 2.7（Python 3.7 测试和工作） Ruby >= 2.5 用法 # first, clone repository ~ $ git clone ...
mkdocs-material：使用mkdocs WIP自动生成文档
02-15
mkdocs-material 使用mkdocs WIP自动生成文档 基本用法sudo pip install pipenv pipenv shell 测试本地的mkdocs serve
mkdocs-pandoc, 将mkdocs文档转换为pandoc样式 Markdown的工具.zip
09-18
mkdocs-pandoc, 将mkdocs文档转换为pandoc样式 Markdown的工具 描述这里 MODULE 包含一组过滤器，用于将 mkdocs 样式 Markdown 文档转换为单个 pandoc(1) flavoured... 对于以下情况从mkdocs文档生成PDF或者 EPUB从mkdo
mkdocstrings：来自MkDocs的自动文档来源
02-11
mkdocstrings 来自MkDocs的自动文档来源。 产品特点 与语言无关：与mkdocs一样， mkdocstrings用Python编写，但与语言无关。 这意味着您可以将其用于任何语言，只要为它实现 。 目前，我们只有。 也许您想再捐一个 :winking_face: ？ 支持多个主题：每个处理程序可以提供多个主题。 目前，我们提供 :star: :star: 以及对Python处理程序的ReadTheDocs主题的基本支持。 对其他对象的交叉引用： mkdocstrings使得可以使用经典的Markdown语法： [identifier][]或[title][identifier]来引用Markdown文件中的其他标题。 此功能也与语言无关：您可以交叉引用Markdown页面中显示的任何标题。 如果特定语言的处理程序呈现了已记录对象的标题，则可以引用它们！ Markdown中的内联注入： mkdocstrings
mkdocstrings-crystal：:blue_book:适用于https：github.compawamoymkdocstrings的Crystal语言文档生成器
02-05
mkdocstrings-crystal 通过用于语言doc生成器。 介绍 mkdocstrings-crystal允许您将API文档（从的源代码和doc注释生成）插入为站点上任何页面的。 要安装它，请运行（可能在）： pip install mkdocstrings-crystal 继续到。 用法 使用 ，将此基本配置添加/合并为您的mkdocs.yml ： site_name : My Project theme : name : material plugins : - search - mkdocstrings : default_handler :
mkdocs-exclude:一个mkdocs插件，可让您从输出中排除文件或树
05-23
适用于mkdocs的文件排除插件 mkdocs-exclude是一个，可让您使用Unix样式的通配符（glob）或正则表达式（regexes）从输入中排除文件。 这实现了人们在某些mkdocs错误（例如和。 快速开始 使用pip安装模块： pip3 install mkdocs-exclude 在您的项目中，将插件配置添加到mkdocs.yml ： plugins : - exclude : glob : - exclude/this/path/* - " *.tmp " - " *.pdf " - " *.gz " regex : - ' .*\.(tmp|bin|tar)$ ' 您可以提供每种类型的零个或多个模式。 （如果您不提供任何模式，那么将不会发生任何事情！）
PDF文档生成器，小而精干
12-03
PDF文档制作工具，省去Acrobat庞大臃肿的功能
MkDocs 文档生成逻辑浅析
极光推送的专栏
02-09 903
Markdown 和 MkDocs 简介 Markdown 的语法简洁明了、学习容易，而且功能比纯文本更强，因此有很多人用它写博客。世界上最流行的博客平台 WordPress 和大型 CMS 如 Joomla 、Drupal 都能很好的支持 Markdown 。 MkDocs 是一个用于创建项目文档的快速，简单的静态站点生成器。文档源码使用 Markdown 来撰写，用一个 YAML 文件作为
使用 mkdocs 自动生成页面，文档中心。
freewebsys的专栏
01-31 5939
本文的原文连接是: http://blog.csdn.net/freewebsys/article/details/71261179 1，关于mkdocs MkDocs 可以同时编译多个markdown文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。 MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个
（二）MkDocs学习笔记——撰写文档
weixin_44639164的博客
12-29 1755
撰写文档 - MkDocs 中文文档 Writing Your Docs - MkDocs 如何撰写 markdown 源码并安排目录结构. 目录结构 文档是普通的 Markdown 文件, 放到项目目录里. 通常目录以 docs 命名, 和 mkdocs.yml 配置文件一起放置于项目的顶级目录中. 最简单的项目目录结构可能是这样的: mkdocs.yml docs/ index.md 默认项目主页是 index. Markdown 源码文件的后缀可以是以下任意一种: markdown, m.
mkdocs搭建文档系统（基础入门）
nonlinearthink的博客
04-02 2272
mkdocs是一个基于python的静态网页构建框架，非常简单和易于管理，几乎不需要任何python和web开发基础，只需要markdown的编写就可以。 安装 pip install mkdocs 创建第一个项目 # project是你的项目名字 mkdocs new project code project 本地打开serve mkdocs serve 打开localhost:8000可...
vscode文档生成插件
07-27
你可以使用以下几个VSCode文档生成插件： ...2. **Mkdocs**: Mkdocs是一个用Python编写的简单、轻量级的文档生成器，可以将Markdown文件转换为静态HTML网页。它支持自定义主题和插件，具有丰富的扩展性。＊＊＊

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值