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.hqwc.cn/news/438369.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

大数据StarRocks(八):资源隔离实战

前言 自 2.2 版本起,StarRocks 支持资源组管理,集群可以通过设置资源组(Resource Group)的方式限制查询对资源的消耗,实现多租户之间的资源隔离与合理利用。在 2.3 版本中,StarRocks 支持限制大查询&#…

qt5-入门

参考: qt学习指南 Qt5和Qt6的区别-CSDN博客 Qt 学习之路_w3cschool Qt教程,Qt5编程入门教程(非常详细) 本地环境: win10专业版,64位 技术选择 Qt5力推QML界面编程。QML类似HTML,可以借助CSS进…

LabVIEW机械臂轨迹跟踪控制

介绍了一个使用LabVIEW开发的机械臂轨迹跟踪控制系统。该系统的主要目标是实现对机械臂运动轨迹的精确控制,使其能够按照预定路径进行精确移动。此系统特别适用于需要高精度位置控制的场合,如自动化装配、精密操作等。 为了实现LabVIEW环境下的机械臂轨迹…

React 组件生命周期-概述、生命周期钩子函数 - 挂载时、生命周期钩子函数 - 更新时、生命周期钩子函数 - 卸载时

React 组件生命周期-概述 学习目标: 能够说出组件的生命周期一共几个阶段 组件的生命周期是指组件从被创建到挂在到页面中运行,在到组件不用时卸载组件 注意:只有类组件才有生命周期,函数组件没有生命周期(类组件需要实例化&…

2024最新版IntelliJ IDEA安装使用指南

2024最新版IntelliJ IDEA安装使用指南 Installation and Usage Guide to the Latest JetBrains IntelliJ IDEA Community Editionn in 2024 By JacksonML JetBrains公司开发的IntelliJ IDEA一经问世,就受到全球Java/Kotlin开发者的热捧。这款集成开发环境&#xf…

C#,数据检索算法之插值搜索(Interpolation Search)的源代码

数据检索算法是指从数据集合(数组、表、哈希表等)中检索指定的数据项。 数据检索算法是所有算法的基础算法之一。 本文提供插值搜索(Interpolation Search)的源代码。 1 文本格式 using System; namespace Legalsoft.Truffer.…

Linux实验记录:使用LVM(逻辑卷管理器)

前言: 本文是一篇关于Linux系统初学者的实验记录。 参考书籍:《Linux就该这么学》 实验环境: VmwareWorkStation 17——虚拟机软件 RedHatEnterpriseLinux[RHEL]8——红帽操作系统 备注: 硬盘分好区或者部署为RAID磁盘阵列…

Java多线程--同步机制解决线程安全问题方式一:同步代码块

文章目录 一、介绍二、原理三、同步锁机制(1)synchronized的锁是什么(2)同步操作的思考顺序(3)代码演示 四、同步代码块(1)同步代码块--案例11、案例12、分析同步原理3、案例1之this…

堆和堆排序【数据结构】

目录 一、堆1. 堆的存储定义2. 初始化堆3. 销毁堆4. 堆的插入向上调整算法 5. 堆的删除向下调整算法 6. 获取堆顶数据7. 获取堆的数据个数8. 堆的判空 二、Gif演示三、 堆排序1. 堆排序(1) 建大堆(2) 排序 2.Topk问题 四、完整代码1.堆的代码Heap.cHeap.htest.c 2. 堆排序的代码…

Ubuntu本地部署Nextcloud并结合内网穿透实现远程访问搭建个人云盘

🌈个人主页: Aileen_0v0 🔥热门专栏: 华为鸿蒙系统学习|计算机网络|数据结构与算法 ​💫个人格言:“没有罗马,那就自己创造罗马~” 文章目录 摘要1. 环境搭建2. 测试局域网访问3. 内网穿透3.1 ubuntu本地安装cpolar3.2 创建隧道3.3 测试公网访…

PCB的层叠结构介绍

1. PCB 单层板 剖去我们不要的,然后放入电阻 但是铜皮非常脆弱,很容易断,所以我们放在一块木板上 我们把铜皮放在基板上 显而易见基板肯定是绝缘的 此时单层板就诞生了 此时问题就诞生了,铜皮过电流是有电的,很容易触…

监听项目中指定属性数据,点击或模块显示时

当项目中,需要获取某个页面上、某个标签上、有指定自定义属性时,需要在点击该元素时进行公共逻辑处理,或该元素在显示的时候进行逻辑处理,这时可以定义一个公共的方法,在每个页面引用,并写入数据即可 &…