2分钟

课程背景

实验预计耗时:30 分钟

1. 课程背景

1.1 课程目的

在个人工作学习中,我们可以使用markdown笔记来记录个人学习心得、感想等,通过使用MkDocs工具可以将markdown文件转换成静态的html网站,方便我们更好的查看并管理自我知识体系。本课程将基于MkDocs生成的Wiki静态网站,演示使用MkDocs进行本地部署的过程,以及通过腾讯云COSCMD工具将静态Wiki部署到腾讯云COS的过程。相比于本地部署,使用腾讯云COS托管静态网站的方式不占用本地服务器资源,且具有高扩展性、低成本、可靠安全等优点,用户还可以通过控制台、API、SDK 和工具等多样化方式,简单、快速地接入 COS,进行多格式文件的上传、下载和管理,实现海量数据存储和管理。

1.2 课前知识准备

1.相关概念:

  • pip:pip 是 Python 包管理工具,该工具提供了对Python 包的查找、下载、安装、卸载的功能。本实验将使用pip来安装腾讯云COSCMD工具。
  • 静态网站:网站仅由html,CSS,JavaScript等前端文件组成的网站。静态网站没有与后端的数据交互,功能简单,要修改网站内容只能修改静态文件。
  • 静态Wiki:静态Wiki指的也是一种静态网站。Wiki指的是网络上开放且可供多人协同创作的超文本系统。本实验更多的体现为一个知识管理系统,类似于个人笔记与博客。实验将使用MkDocs来生成静态Wiki,以markdown格式编写,通过静态html的方式呈现。
  • MkDocs:MkDocs 是一个用于创建项目文档的快速、简单、完美华丽的静态站点生成器。文档源码使用markdown来撰写, 用一个YAML文件作为配置文档。本实验将使用MkDocs来生成并部署静态Wiki网站。
  • 腾讯云云服务器:腾讯云服务器 CVM(Cloud Virtual Machine)是腾讯云提供的可扩展的计算服务。使用 CVM 避免了使用传统服务器时需要预估资源用量及前期投入,可以在短时间内快速启动任意数量的云服务器并即时部署应用程序。本实验模拟本地部署时需用到腾讯云CVM,相关云服务器概念可以参考腾讯云文档中心https://cloud.tencent.com/document/product/213/495
  • 腾讯云COS:对象存储(Cloud Object Storage,COS)是腾讯云提供的一种存储海量文件的分布式存储服务,用户可通过网络随时存储和查看数据。腾讯云 COS 使所有用户都能使用具备高扩展性、低成本、可靠和安全的数据存储服务。通过 COS 可以进行多格式文件的上传、下载和管理。本实验将基于腾讯云COS来演示部署静态Wiki。
  • 腾讯云COSCMD:COSCMD是腾讯云开发的一款COS命令行工具,用户可通过简单的命令行指令实现对对象(Object)的批量上传、下载、删除等操作。本实验将使用COSCMD工具来上传静态Wiki相关文件。

2.相关原理:

  • 本地部署:指代使用本地服务器部署的方式,在本实验中将使用腾讯云CVM来模拟生产时所用的本地服务器。服务器端需要在CVM中启动MkDocs服务以提供web资源访问,当用户发送web资源请求后将静态Wiki页面返回给用户。
本地部署
  • 基于腾讯云COS部署:将静态资源文件上传到腾讯云COS,是一种云化部署方式。其本质在于COS本身就是一个分布式服务器,可以用来存放海量数据以提供静态资源访问。相比于本地部署方式,使用腾讯云COS不需要准备额外的服务器资源,节省服务器空间,并且具有快速扩容、带宽更大、响应速度更快、支持跨域等诸多优点。
腾讯云COS部署

3.相关命令介绍:

1.linux基础相关命令:

  • 进入XXX目录
cd XXX
  • 查看当前目录下的文件及文件夹
ls -l
  • 使用Vim编辑器编辑 index.md 文件
vim index.md

2.环境安装相关命令:

  • 安装pip
sudo apt install python-pip -y
  • 安装MkDocs
sudo apt-get install mkdocs -y
  • 使用pip安装COSCMD工具
pip install coscmd

3.MkDocs相关命令:

  • 查看MkDocs版本
mkdocs --version
  • 新建一个名为my-Wiki的MkDocs项目
mkdocs new my-Wiki
  • 在80端口上运行MkDocs
sudo mkdocs serve -a 0.0.0.0:80
  • 构建静态Wiki页面
mkdocs build

4.腾讯云COSCMD相关命令

  • COSCMD默认参数配置
coscmd config -a <SECRET_ID> -s <SECRET_KEY> -b <BucketName-APPID> -r <REGION>
  • 上传到site目录下所有文件到存储桶根目录下
coscmd upload -r ~/my-Wiki/site/ /