一、前言:
什么是Cloud Studio呢?
Cloud Studio是一个基于浏览器的集成式开发环境(IDE),为开发者提供了一个永不间断的云端工作站。用户在使用 Cloud Studio 时无需安装,随时随地打开浏览器就能在线编程。
Cloud Studio 作为在线 IDE,包含代码高亮、自动补全、Git 集成、终端等 IDE 的基础功能,同时支持实时调试、插件扩展等,可以帮助开发者快速完成各种应用的开发、编译与部署工作。
二、快速体验Cloud Studio,混个眼熟:
MkDocs是一个快速的、简单的、优美的静态站点生成器,主要用于构建项目文档。文档源文件采用Markdown格式,配置文件采用一个YAML格式文件。
MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.
– 任意托管:构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方.
– 大量主题:默认包含大量美观的主题. 可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择.
– 即时预览:内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改.
– 易于配置:可以配置文档主题.
– 交叉索引:使用 MkDocs 链接语法创建交叉索引.
1. 传统方式安装mkdocs:
安装mkdocs前需要安装python环境。mkdocs要求python版本为:python 3.5、python 3.6 、python 3.7和python 3.8。
需要 Python 和 Python package manager pip 来安装 MkDocs . 可以通过以下命令查看是否安装了上述依赖:
$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2
安装mkdocs非常简单,只需要在控制台运行如下命令即可:
pip install mkdocs
查看mkdocs是否安装成功,只需要运行如下命令:
mkdocs --version
如果提示不能运行mkdocs命令,简单的解决方法只需要在命令前加上python -m,即:
python -m mkdocs --version
我们只需要运行如下命令,就可以创建一个站点:
mkdocs new dir_name
在创建的目录下,有一个子目录docs,其中包含了源文件、页面等数据;
在创建的目录下,有一个文件mkdocs.yml,这就是配置文件;
然后进入我们创建的目录learn_mkdocs,运行如下命令,即可在本地访问站点:
mkdocs serve
这样,我们就可以搭建起来一个mkdocs,但是我分析一下,从最开始到完成搭建,需要哪些东西?
- 电脑需要安装python环境,还要安装pip包管理工具
- 本地需要有一个IDE写代码使用
- 还需要买个一服务器进行公网的部署,不然,你放到本地,给谁看呢?
- 还要备案,买域名
以上的操作,非常麻烦,尤其是换了主机,本的环境和工具体系不能复用,下面我们来体验一下Cloud Studio怎么快速来搭建系统。
2. Cloud Studio方式安装mkdocs:
选择建站模板“mkdocs-base”,点击即可进入。
直接自动安装好环境,并执行依赖,打开Mkdocs中。
cd ./ && pip install -r requirements.txt && mkdocs serve
以上,不花费吹灰之力,就完成了Cloud Studio的搭建。
三、搭建简单的博客:
我们可以修改mkdocs.yml文件中的站点名site_name:
可以看到修改后,可以实时刷新显示,非常的方便。
添加页面
在入门使用中,mkdocs为我们创建了一个页面index.md,可以自己添加页面,比如,在docs目录下创建页面about.md,页面内容如下:
配置主题
可以在配置文件中修改文档主题. 在 mkdocs.yml 中添加如下内容:
site_name: cloudstudio 学习
pages:
- [index.md, Home]
- [about.md, About]
站点生成
我们现在已经可以发布 MkLorum 文档了. 通过以下命令生成文档.
$ mkdocs build
该命令创建了一个 site 新目录. 可以通过以下命令浏览该目录内容:
$ ls site
about css fonts img index.html js
注意源码被分别输出为 index.html 和 about/index.html. 主题中的其他文件也被复制到了 site 目录中.
如果你使用 git 等版本控制系统, 你可能不希望提交构建之后的文档到版本库. 在 .gitignore 中添加 site/ 即可忽略该目录.
$ echo "site/" >> .gitignore
如果你使用其他版本控制系统则需要查阅相关文档以确定如何忽略指定目录.
一段时间后, 可能有文件被从源码中移除了, 但是相关的文档仍残留在 site 目录中. 在构建命令中添加 --clean 参数即可移除这些文档.
$ mkdocs build --clean
查看工作空间:
总结:
经过手册学习和自己动手实践了一下,感觉腾讯云 Cloud Studio非常实用,能够帮助我们提高开发效率,而且非常的方便,支持!