30分钟做一个文档中心.pdf
免费下载
30分钟做⼀个⽂档中⼼
如何快速将技术⽂档、开发笔记转化为结构清晰、易于浏览的⽹⻚形式，统⼀对外提供⽂档服务尤为重要。
搞定这样⼀个⽹站需要多久？
图为借⽤
PolarDB
⽂档界⾯，⾮实际案例，意在说明可建构这样的⼀个
“
树结构导航，锚点操作的多⽂档⽹站
”
。
⼀个⽉？⼀周？⼀天？不会是1⼩时吧
不，30分钟够⽤了。
!
以下围绕在 Linux 下安装 MkDocs 展开详细介绍，帮助⽤户系统掌握其使⽤⽅法，快速搭建属于⾃⼰的⽂档⽹
站。
!
1.环境准备：2分钟
CentOS7.9＋python3.8+pip 9以上
⽂档：Markdown格式
⾸先，登录操作系统，查询 Python 和 pip是否已就绪
python3 --version ! ! # 确保版本 >= 3.8
pip3 --version ! ! ! # 确保版本 >= 9.0.0
如未安装或版本过低，可参考系统包管理器安装：
!
2. 安装 MkDocs 及常⽤插件 5分钟
建议使⽤清华 PyPI 镜像加速下载：
如需特定版本，可指定，例如：
验证安装是否成功：
!
3. 创建项⽬并初始化结构 1分钟
此时 mydocs/ ⽬录结构如下：
!
4. 添加或编辑⽂档内容 10分钟
将远程服务器的 mydocs ⽂件打包
sudo yum update
sudo yum install python3 python3-pip
python3 -m pip install mkdocs -i https://pypi.tuna.tsinghua.edu.cn/simple
python3 -m pip install mkdocs-material mkdocs-autorefs -i
https://pypi.tuna.tsinghua.edu.cn/simple
pip3 install mkdocs-material -i https://pypi.tuna.tsinghua.edu.cn/simple
pip3 install mkdocs-autorefs -i https://pypi.tuna.tsinghua.edu.cn/simple
pip3 show mkdocs
mkdocs new mydocs
cd mydocs
mydocs/
├── docs/
│ ! └── index.md
└── mkdocs.yml
tar -czvf mydocs.tar.gz mydocs/
of 7
免费下载
【版权声明】本文为墨天轮用户原创内容，转载时必须标注文档的来源（墨天轮），文档链接，文档作者等基本信息，否则作者和墨天轮有权追究责任。如果您发现墨天轮中有涉嫌抄袭或者侵权的内容，欢迎发送邮件至：contact@modb.pro进行举报，并提供相关证据，一经查实，墨天轮将立刻删除相关内容。
下载排行榜
文档被以下合辑收录
评论