当前位置: 首页 > news >正文

MkDocs 部署指南

简介

MkDocs 可以同时编译多个 markdown 文件,形成书籍一样的文件。有多种主题供你选择,很适合项目使用。

MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。

MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点:

1.1 任意托管

构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。

1.2 大量主题

默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。

1.3 即时预览

内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。

1.4 易于配置

可以配置文档主题。

1.5 交叉索引

使用MkDocs链接语法创建交叉索引。

部署


mkdir -p /opt/mkdocsdocker pull squidfunk/mkdocs-materialdocker run -it --rm -v /opt/mkdocs:/docs squidfunk/mkdocs-material new cc-docsdocker run -it  --name mkdocs --restart=always -v /opt/mkdocs:/docs -p 10025:8000  --workdir /docs/cc-docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000

使用

浏览器

http://192.168.168.111:10025/

1.首页

2.编辑自己的网站

cd /opt/mkdocs/cc-docs

修改内容为

site_name: king
nav:-  Home: index.md-  Blog: mkdocs介绍.md

刷新页面,发现你页面内容变了

3.再次编辑自己的网站

进入目录

cd /opt/mkdocs/cc-docs/docs

 

编写写页面内容

vim mkdocs介绍.md

内容为:

##mk简介
MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它>具有如下几个优点:###1.1 任意托管构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。###1.2 大量主题默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。###1.3 即时预览内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。###1.4 易于配置可以配置文档主题。###1.5 交叉索引使用MkDocs链接语法创建交叉索引。

再次刷新页面

发现Blog下有内容了

http://www.lryc.cn/news/290147.html

相关文章:

  • 【Java 设计模式】行为型之访问者模式
  • 堆和堆排序【数据结构】
  • 【全程录屏GPT3.5升级4.0】2024最新GPT4升级订阅详细指南
  • 中移(苏州)软件技术有限公司面试问题与解答(4)—— virtio所创建的设备1
  • 《动手学深度学习(PyTorch版)》笔记5
  • QT中wchar_t类型如何输出
  • 网络安全04-sql注入靶场第一关
  • 微服务理解篇
  • 项目篇:基于TCP通信模型的外卖软件实现
  • 深入浅出 diffusion(2):pytorch 实现 diffusion 加噪过程
  • 【软件测试】学习笔记-构建并执行 JMeter 脚本的正确姿势
  • iOS 面试 Swift基础题
  • (七)for循环控制
  • ASP .NET Core Api 使用过滤器
  • CodeGPT--(Visual )
  • 1.Mybatis入门
  • android camera系列(Camera1、Camera2、CameraX)的使用以及输出的图像格式
  • live555搭建流式rtsp服务器
  • Apache孵化器领路人与导师的职责
  • 【C++中STL】set/multiset容器
  • 使用 create-react-app 创建 react 应用
  • obs-studio 源码学习 obs.h
  • C语言-指针的基本知识(上)
  • 4核16G幻兽帕鲁服务器优惠价格表,阿里云和腾讯云报价
  • GitHub 上传文件夹到远程仓库、再次上传修改文件、如何使用lfs上传大文件、github报错一些问题
  • 一些es的基本操作
  • 酒鬼酒2024年展望:稳发展动能,迈入恢复性增长轨道
  • 1002. HarmonyOS 开发问题:鸿蒙 OS 技术特性是什么?
  • vue-cli 无法安装问题解决
  • spring-bus消息总线的使用