使用MKDocs构建Markdown格式API文档(macOS)

最新推荐文章于 2024-04-29 09:56:00 发布
最新推荐文章于 2024-04-29 09:56:00 发布
阅读量4.3k 收藏 2
点赞数 1
分类专栏： GitBook&MkDocs 文章标签： markdown mkdocs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WSYW126/article/details/51997395
版权

  1. MkDocs是什么?

    MKDocs就是一个能快速，简单，优雅的生成静态文档站点的项目。文档用Markdown书写，目录用YAML配置，弄好之后你可以把它放到Github的Pages 上，或者自己服务器上就可以了。并且也有好几套UI供你选择MkDocs UI，特别适合那些做开源项目的童鞋，生成说明文档使用。总的来说，就是省时省力，效果还不错

  2. 安装

    我的机子装了brew，所以可以直接命令行安装软件。

    1. 安装Python

      在终端输入下面指令：brew install python

      查看版本：

      python --version
Python 2.7.10

    2. 安装mkdocs

      在终端输入下面指令：pip insta

最低0.47元/天 解锁文章
WSYW126
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Python mkdocs包的meta.py源码文件解析与使用
hongwen_han的博客
07-15 518
Python mkdocs包的meta.py源码文件解析与使用，根据meta.py提取markdown文件的meta基础信息，实现markdown文档的基础数据读取。
【小沐学Python】Python实现在线电子书制作（MkDocs + readthedocs + github + Markdown）
爱看书的小沐
06-10 2583
MkDocs是一个快速、简单、华丽的静态网站生成器，适用于构建项目文档。文档源文件以Markdown编写，并使用一个YAML文件来进行配置。在任何地方部署MkDocs生成完全静态的HTML网站，你可以将其部署到GitHub pages、Amzzon S3或你自己选择的其它任意地方。很棒的主题MkDocs有一堆很好看的主题。官方内置了两个主题：mkdocs和readthedocs，也可以从MkDocs wiki中选择第三方主题，或者自定义主题。实时预览你的网站。
MarkDown 接口模板
最新发布
forevercui的博客
04-29 361
【代码】MarkDown 接口模板。
【mkdocs文档加密保护插件】
weixin_43891607的博客
01-10 468
mkdocs 文档加密 插件
api markdown 模版
哈
11-03 983
【代码】api markdown 模版。
markdown 文档 api
然后他就拿棍子来打我
09-16 1836
vsCode 编辑器 + Markdown 插件。
formatting:使用MkDocs构建的Markdown格式指南
04-02
这篇“formatting:使用MkDocs构建的Markdown格式指南”将详细介绍如何利用Markdown语法和MkDocs来构建专业且美观的文档网站。以下是一些关键知识点： 1. **Markdown基本语法**： - **标题**：使用“#”符号来定义...
mkdocs：使用Markdown的项目文档
02-03
Markdown的项目文档。 查看。 项目。 访问获取社区资源，包括第三方主题和MkDocs用户列表。 IRC频道：freenode上的#mkdocs 。 讨论和支持： : 行为守则 希望在MkDocs项目的代码库，问题跟踪器，聊天室和邮件...
bocco：从Markdown生成API文档
02-04
博科受和启发， 是一种从生成Backbone风格文档的快速方法。 应该与产生的markdown基本兼容，因此您可以将文档提交到github。 示例：安装sudo npm install -g bocco用法bocco file.md > output.html
github-markdown-render：使用GitHub的Markdown渲染API和CSS在本地Web服务器上显示Markdown格式的文档，以模仿GitHub本身的视觉效果
02-04
使用GitHub的和CSS在本地开发Web服务器上显示格式的文档，以模仿GitHub本身的可视显示。 方便在项目存储库中创作/预览README.md文件（或与此有关的任何Markdown），希望避免由于过多的错别字/错误而在提交日志中...
pydoc-markdown：以Markdown格式创建Python API文档
02-04
Pydoc降价Pydoc-Markdown是一个工具和库，可基于lib2to3以Markdown格式创建Python API文档，从而允许它解析Python代码而不执行它。 Pydoc-Markdown需要Python 3.6或更高版本，但是要为其生成API文档的代码可以适用于...
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)$ ' 您可以提供每种类型的零个或多个模式。 （如果您不提供任何模式，那么将不会发生任何事情！）
markdown-api模板.md
03-09
markdown开发接口文档模板, 最近公司开发项目需要前后端分离，这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用，因此编写API文档非常有必要了 网上查了很多资料，发现基于Markdown编写文档是一种比较流行而且成熟的方案了，话不多说，我也搞一搞试试。
mkapi：MkDocs的文档生成工具
02-04
MkApi MkApi插件生成用于Python代码API文档。 MkApi支持两种类型的文档字符串：和 。 MkApi的功能有： 类型注释：如果您编写函数，例如def func(x: int) -> str:则无需再次在Parameters，Returns或Yields部分中写入类型。 您可以覆盖相应文档字符串中的类型注释。 对象类型检查：MkApi插件针对每个对象创建类，数据类，函数或发电机前缀。 属性检查：如果在模块或类中编写带有描述作为注释的属性，则会自动创建“属性”部分。 文档字符串继承：子类的文档字符串可以从其超类继承参数和属性描述。 目录：将目录插入每个包，模块和类的
使用 mkdocs 自动生成页面，文档中心。
freewebsys的专栏
01-31 5939
本文的原文连接是: http://blog.csdn.net/freewebsys/article/details/71261179 1，关于mkdocs MkDocs 可以同时编译多个markdown文件，形成书籍一样的文件。有多种主题供你选择，很适合项目使用。 MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个
MkDocs 快速入门
热门推荐
毕小烦的学习笔记
10-08 2万+
本文选自《Markdown 实用指南》 作者：毕小烦MkDocs 是一个用 Python 开发的静态站点生成器工具，它可以非常简单快速的创建项目文档。MkDocs 的文档源码使用 Markdown 编写，配置文件使用 YAML 编写，可以一键编译成静态站点。很多开源的项目文档都使用 MkDocs 编写，因此我们非常有必要学习一下。环境 支持 macOS/Linux/Windows 安装 Python
(mkdocs)一款使用markdown编写website的插件
weixin_34019144的博客
01-06 325
2019独角兽企业重金招聘Python工程师标准>>> ...
python3 使用Mkdocs 开发项目文档
ck07
12-10 1028
首先使用 pip 安装 mkdocs : $ pip install mkdocs 在terminal 输入以下命令行: mkdocs new my-project cd my-project到目录位置 看到以上目录 MkDocs 包含了一个内建的服务器以预览当前文档. 控制台切换当前目录到 mkdocs.yml 配置文件相同文件夹 在terminal 输入以下命令行 ...
Python 文档生成器 mkdocs
sushengbuhuo的博客
06-16 1111
mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器，中文文档地址 使用 mkdocs 我们可以用 md 编写自己的文档，而且可以免费部署到 GitHub 。 安装 pip install mkdocs 新建文档 λ mkdocs.exe new mydoc INFO - Creating project directory: mydoc INFO - ...
Markdown代码api文档模板
06-06
以下是一个简单的Markdown代码API文档模板，你可以根据需要自行修改和添加内容： # API文档 ## 接口名称 接口功能简述。 **接口地址：** `/api/xxx` **请求方式：** `POST` ### 请求参数 | 参数名 | 必选 | ...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值