杜郎俊赏 - dujun.io

开源实例之MkDocs

前言

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

MkDocs 是一个用于创建项目文档的快速、简单、完美华丽的静态站点生成器。文档源码使用 Markdown 来撰写,用一个 YAML 文件作为配置文档。

实例地址

http://mkdocs.dujun.eu.org

实例配置

配置描述
系统Debian
开发环境服务端Python 3.9
服务器Nginx
程序MkDocs 1.4.3

实例部署

权限要求

  • 具有系统读写权限
  • 已安装 Python
  • 已安装 Nginx

安装程序

官网地址:https://www.mkdocs.org
仓库地址:https://github.com/mkdocs/mkdocs

#安装 MkDocs
pip install mkdocs

#创建项目
mkdocs new web
cd web

#生成静态文件
mkdocs build

实例体验

进入实例深度体验

后记

本实例仅供参考,不定期重置数据。

体验更多开源实例

标签: 开源实例 Python实例 文档生成工具实例 生产实例
日期:2023-06-12