1.介绍MkDocs

于 2024-07-10 05:53:36 发布
阅读量402 收藏 6
点赞数 3
分类专栏： MkDocs 文章标签： 短文合集/MkDocs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38641599/article/details/140311885
版权

MkDocs

简介

MkDocs 是一个简单且快速的静态网站生成器，专门用于项目文档。它使用Markdown文件作为内容源，基于Python构建，易于配置和使用。

主要特性
  • 易于安装和使用：通过Python包管理器安装，配置简单。
  • 主题支持：提供多种主题，支持自定义。
  • 自动生成导航：根据Markdown文件自动生成站点导航。
  • 内置开发服务器：实时预览文档修改。
  • 插件扩展：支持插件机制，增加额外功能。
安装

创建Python虚拟环境

更新包列表
sudo apt update

安装python环境
sudo apt install python3 python3-pip python3-venv -y

python虚拟环境
python3 -m venv .python-venv/

激活python虚拟环境
source .python-venv/bin/activate

更新虚拟环境的 pip
.python-venv/bin/pip install --upgrade pip
squidfunk版本

squidfunk 的网站

pip（先创建Python虚拟环境）

pip install mkdocs-material

Docker

git clone https://github.com/squidfunk/mkdocs-material.git
pip install -e mkdocs-material

Github

docker pull squidfunk/mkdocs-material

!!! info "适用 Debian/Ubuntu 系统"

‍

官方版本

MkDocs、插件、主题

pip install mkdocs -U
pip install "mkdocstrings[python]" -U
pip install mkdocs-material -U

‍

验证安装

mkdocs --version
配置示例

在mkdocs.yml​文件中添加基本配置：

site_name: My Docs

theme:
  name: material
目录结构示例
my-project/
    mkdocs.yml    # 配置文件
    docs/
        index.md  # 首页内容
        guide.md  # 指南内容

‍

以下网站使用MkDocs构建

教程

排版

可以从这些网站学习的排版。这几天看过了搜到的所有教程，我推荐您只看Material for MkDocs (squidfunk.github.io)和 视频参考 就够了。

‍

‍

灵魂信息
关注
专栏目录
MkDocs 目录插件指南
gitblog_00484的博客
08-27 830
MkDocs 目录插件指南 catalog:trophy: :books: A list of awesome MkDocs projects and plugins. 项目地址:https://gitcode.com/gh_mirrors/cata/catalog 项目介绍 MkDocs 是一个轻量级且易于使用的静态站点生成器，专为技术文档设计。通过这个插件——MkDocs 目录插件，您可以...
（五）MkDocs学习——配置文件
weixin_44639164的博客
12-29 2285
简介 始终使用名为mkdocs.yml的位于项目目录中的YAML文件来进行设置。（当然也可以将mkdocs.yml放置其他目录，需要在build时做命令调整，使用-f/--config-file 选项） 此配置文件必须包含site_name与site_url设置。 所有其他设置都是可选项。 项目信息 site_name 这是一个必需的设置，应该是一个字符串，用作项目文档的主标题。 例如： site_name: Marshmallow Generator 渲染主题时，此设置将作为site_name上下文变
（二）MkDocs学习笔记——撰写文档
weixin_44639164的博客
12-29 1878
撰写文档 - MkDocs 中文文档 Writing Your Docs - MkDocs 如何撰写 markdown 源码并安排目录结构. 目录结构 文档是普通的 Markdown 文件, 放到项目目录里. 通常目录以 docs 命名, 和 mkdocs.yml 配置文件一起放置于项目的顶级目录中. 最简单的项目目录结构可能是这样的: mkdocs.yml docs/ index.md 默认项目主页是 index. Markdown 源码文件的后缀可以是以下任意一种: markdown, m.
so easy！从头教你用mkdocs构建个人博客系统~
水木子的博客
04-22 7662
本文主要介绍如何使用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搭建网站及过程中的问题记录
swust_fang
07-11 1014
GiantPandaCV 一直是以公众号的形式和大家见面，但现在随着分享干货的日益增多，我们不满足于公众号小小的窗口，为了方便大家快速检索自己感兴趣的知识，也为了增加和大家的交流， GiantPandaCV.COM 应运而生。以下为网站搭建过程，有小伙伴需要搭建自己个人博客网站，项目文档网站，可以作为参考。 MkDocs 简介 公众号日常文章都以 Markdown 形式交付BB，通过一定方式转化为公众号可读形式给大家阅读。基于此，我们选择了MkDocs 作为网站首选。 MkDocs 是一个用于创建项目文档的
SaDS-model.github.io：使用MkDocs和GitHub Pages托管文档
02-24
这将在当前目录下创建一个名为 "mydocs" 的新文件夹，包含基本的MkDocs配置文件 `mkdocs.yml` 和一个默认的Markdown文件 `index.md`。 3. **配置MkDocs** 在 `mkdocs.yml` 文件中，你可以定义文档结构、主题、...
PyPI 官网下载 | mkdocs-with-pdf-0.8.1.tar.gz
01-28
然后，通过在MkDocs的配置文件`mkdocs.yml`中添加mkdocs-with-pdf插件，配置PDF生成选项。最后，通过`mkdocs build`命令生成HTML文档，再使用`mkdocs pdf`命令生成PDF文档。 总结来说，mkdocs-with-pdf-0.8.1.tar....
PyPI 官网下载 | mkdocs-monorepo-plugin-0.4.17.tar.gz
02-10
1. `setup.py`：Python的安装脚本，用于将插件安装到用户的Python环境中。 2. `mkdocs_monorepo_plugin`：插件的核心源代码目录，包含实现特定功能的Python模块和类。 3. `README.md`或`README.rst`：项目的基本介绍...
mkdocs-basic-theme:一个非常简单的MkDocs主题示例
05-07
1. `mkdocs.yml` - 这是MkDocs的配置文件，其中包含了项目的基本信息，如主题设置、菜单结构、页面布局等。 2. `docs` - 存放Markdown源文件的目录，这些文件会被MkDocs处理并转化为HTML页面。 3. `theme` - 自定义...
【云原生之Docker实战】使用docker部署mkdocs项目文档工具
jks212454的博客
12-02 1277
【云原生之Docker实战】使用docker部署mkdocs项目文档工具
使用MKDocs构建Markdown格式API文档(macOS)
WSYW126的博客
07-22 4360
使用MKDocs构建Markdown格式API文档(macOS)
使用 mkdocs 自动生成页面，文档中心。
freewebsys的专栏
01-31 5968
本文的原文连接是: 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项目文档生成器(一)
一路向东
08-31 1万+
简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介类别：项目文档生成器，生成静态站点，管理MarkD
mkdocs
云海天
08-24 2773
mkdocs
Android二手系统报告，项目背景+开发环境+详细设计+运行演示+心得体会，11991字论文，图文并茂，满分课程设计！
10-03
随着互联网技术的飞速发展和智能手机的普及，人们的生活方式发生了巨大的转变。线上购物已成为日常消费的重要组成部分，而二手市场作为其中的一个细分领域，也逐渐受到了广泛关注。尤其是近年来，环保意识的增强和资源节约的倡导，使得越来越多的消费者开始倾向于购买和出售二手商品。 在这样的社会背景下，二手交易系统的需求应运而生。一方面，它能够满足消费者对于低价、实用商品的追求，另一方面，它也为环保事业做出了贡献，减少了资源的浪费。然而，传统的二手交易方式，如线下跳蚤市场、二手店等，存在着信息不对称、交易不便、安全隐患等问题，严重制约了二手市场的进一步发展。 因此，开发一款功能齐全、操作便捷、安全可靠的二手交易系统显得尤为重要。它不仅可以解决传统交易方式的痛点，提高交易效率，还能扩大交易范围，吸引更多的消费者参与进来。同时，通过系统的数据分析功能，我们还能了解市场需求和消费者行为，为商家和政策制定者提供有价值的参考依据。 综上所述，本项目旨在开发一款适应现代社会需求的二手交易系统，以推动二手市场的健康发展，促进资源的循环利用，为构建节约型社会贡献力量。 二手交易系统的开发涉及到了Android平台的多个
无需框架，实现完全连接的神经网络，加深初学者对神经网络计算过程的理解。NeturalNetwork演示.zip
最新发布
10-03
无需框架，实现完全连接的神经网络，加深初学者对神经网络计算过程的理解。NeturalNetwork演示
基于36计策略的Python、JavaScript、HTML、CSS综合实战设计源码
10-03
本项目是一款结合36计策略的综合性实战设计源码，涵盖Python、JavaScript、HTML、CSS等多种编程语言，共计86个文件。其中，包含24个jpg图片文件、20个py Python脚本文件、20个png图片文件、9个js JavaScript脚本文件、5个html网页文件、3个css样式表文件、2个markdown文档文件、1个gitignore配置文件、1个ico图标文件和1个jpeg图片文件。该源码通过巧妙运用瞒天过海、围魏救赵等36计策略，实现了丰富的互动设计和功能演示，适用于学习与探讨编程语言在实际项目中的应用。
如何在mkdocs.yml文件中设置mkdocs的访问控制，比如需要登录才可以查看内容
04-24
2. 在mkdocs.yml文件中添加该插件: 在plugins字段中添加simple。 plugins: - simple 3. 在插件的配置文件中定义访问控制: 创建一个名为simple_auth的YAML文件，在其中定义您的用户列表和密码。示例： users: ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值