自动拉取 GitHub 仓库更新的脚本 ---- 由于将 HAUE-CS-WIKI 部署到了我自己的服务器上作为国内镜像站，每次在源站更新后都需要手动拉取镜像站的更新实在是太麻烦了，因此产生了编写该脚本的需求...---- 脚本思路 ---- 编写脚本文件，能够执行 git pull 命令以及 mkdocs build 构建命令。 对这些命令的执行结果和状态需要保存到相应的日志，以便查询执行状态。.../etc/profile source /root/.bashrc source /root/.profile # 导入 mkdocs 环境变量 MKDOCS_PATH="/usr/local/bin.../mkdocs" # 日志文件路径 LOG_FILE="/wiki/log/update.log" ERROR_LOG_FILE="/wiki/log/error.log" # 任务执行时间 update_time...# 执行 mkdocs 构建 mk_build_output=$($MKDOCS_PATH 2>&1) mk_build_status=$?
安装 Mkdocs 及主题 1、 安装 mkdocs pip install mkdocs 2、 新建项目 mkdocs new my-project cd my-project 3、 撰写文档 进行到这一步会发现...Operation-System/Windows/index.md - OS X: Program-OS/Operation-System/OS-X/index.md 需注意：最后一级导航指向md文件，在此之前的上一集菜单...: 后必须留空。...其中，第一行指定使用 python:alpine Docker 镜像，before_script 节点下的两条指令为使用清华的 Python 镜像站 安装 mkdocs 及 mkdocs-material...之后提交，触发构建，解决问题，完成。 参考文献 mkdocs mkdocs-material GitLab Pages administration GitLab Runner Docs
MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。...MkDocs 基于 python，但只需编写 Markdown 就可构建最简单的文档页面 安装 使用 pip 安装 MkDocs pip install mkdocs-material 创建项目 使用如下指令创建一个名为...右下角的超链接 social: - icon: fontawesome/brands/github link: # name: github 复制 编写 Markdown 并构建网页...编写前可以创建一个实时预览的服务器 mkdocs serve 在docs/中创建的md文件将会实时同步到预览服务器 完成编辑后使用 mkdocs build 即可生成静态网页文件，可以部署到github...pages或者你的个人服务器上
Mkdocs介绍 MkDocs是一个快速、简单的静态网站生成器，适用于构建项目文档。源文件以 Markdown 格式编写，并使用单个 YAML 配置文件进行配置。 2....环境搭建 环境包括python、pip，在此基础上安装mkdocs。...nav导航文件 站点生成： mkdocs build 博客编译后，生成site文件夹 ls site echo site/ >> .gitignore 如果你使用 git 等版本控制系统, 你可能不希望提交构建之后的文档到版本库...在 .gitignore 中添加 site/ 即可忽略该目录. mkdocs build --clean 一段时间后, 可能有文件被从源码中移除了, 但是相关的文档仍残留在 site 目录中....在构建命令中添加 --clean 参数即可移除这些文档. 站点部署： mkdocs gh-deploy (这个分支放生成的站点) master （这个分支放md） 效果如下： 4.
MkDocs 使用Markdown的项目文档。 概观 MkDocs是一个快速，简单且彻头彻尾的华丽静态站点生成器，旨在构建项目文档。...---- （假设大家已经安装Python） 安装MkDocs mkdocs使用pip 安装包： pip install mkdocs 您现在应该mkdocs在系统上安装该命令。...一段时间后，文件可能会从文档中删除，但它们仍将驻留在site目录中。要删除这些陈旧文件，只需mkdocs 使用--clean开关运行即可。...有关命令的完整列表，请使用--help标志： mkdocs --help 要查看给定命令上可用的选项列表，请使用--help带该命令的标志。...获得帮助 要获得有关MkDocs的帮助，请使用讨论组，GitHub问题或#mkdocsfreenode上的MkDocs IRC频道。 ---- 有兴趣的朋友可以阅读原文跳转到MkDocs网站浏览
将Codeship与Kubernetes相结合 Codeship本身已经在其CI Platform for Docker当中内置有部分Google Cloud集成机制，因此我们可以直接在Google Cloud...上验证并部署新镜像。...在完成了加密环境文件的创建并将Google Cloud环境变量保存至gc.env.encrypted后，接下来我们需要在codeship-services.yml文件内定义Google Cloud服务。...虽然其已经创建了与Google Cloud交换所需要的服务，但并不能自动部署新构建的镜像或者更新Kubernetes Deployment。...由于未设置Docker镜像标签，因此Codeship将把更新镜像推送至latest标签。
Mkdocs 是一个采用 Python 构建轻量级的静态 HTML 在线文档框架，内置部署到 Github Pages 的功能。我用来创建实践指南，用来做个人的知识积累。...HTML 生成和部署 执行mkdocs build会新建site目录，并将 markdown 文件构建为 html 文件。...执行mkdocs gh-deploy就可以site中的 html 内容提交到代码仓库的gh-pages分支上，你要在 Github 上 代码库的配置中起用 Pages 才可以看见站点，地址是 https...通过 Github Actions 部署到 Github Pages 我们可以用 Github Actions 把上述的构建和发布工作自动化，只需要在代码库上新建.github/workflow/gh-deploy.yml...- run: mkdocs gh-deploy --force 提交后，你就可以看到自己的站点自动部署到 Github Pages。
mkdocs build --clean # 创建编译后的静态页面以及样式文件 mkdocs gh-deploy --clean # push到gh-deploy分支下 ?.../cloudnativecosystem_mkdocs/ ?...其中,GITHUB_API_KEY是从gitub上获取的Access Token,剩下的两个是用户名和密码。完成之后，我们就可以手动的触发以下构建: ?...image-20200604235350325 紧接着，我们为了方便我们知道构建是否完成，我们在README.md文件上添加了一个构建的状态展示: ?...复制RESULT信息到readme.md中，即可显示每次构建的状态信息: ? 查看一下我们的构建历史 ? 这样每次推动到Git仓库之后，就会自动的编译好静态文件到gh-deploy分支了.
检测到更改后，Travis CI可以提供有关更改是否成功的反馈。...还有一件事：Circle CI可以自动取消GitHub上的冗余构建。如果在同一分支上触发了较新的构建，则该工具会识别它并取消正在运行或排队的旧构建，即使构建未完成也是如此。...它支持预配置的CI环境，并允许多个不同的构建在同一构建VM上运行。 Codeship Pro使用Docker定义CI / CD环境，通过它可以运行构建管道。...Codeship仪表板 6. GitLab CI GitLab推出后不久，该团队推出了持续集成服务GitLab CI。...之后，每次提交或推送都将触发具有三个阶段的CI管道：构建，测试和部署。 每个构建的可以分为多个作业，并且可以在多台机器上并行运行。
它具有如下几个优点： 1.1 任意托管 构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。 1.2 大量主题 默认包含大量美观的主题。...1.5 交叉索引 使用MkDocs链接语法创建交叉索引。 2 什么是Materialfor MkDocs 一个MkDocs的MaterialDesign主题。...3.1Mkdocs安装 pip install mkdocs 3.2Material for MkDocs安装 pip install mkdocs-material 3.3环境配置 要在cmd上运行mkdocs...配置完后在my-project文件夹下用cmd输入 mkdocs build 完成后会生成一个site文件夹，这个文件夹里的内容就是生成的静态网站。...5 结语 生成的静态网站可以部署到readthedoc和github上。团队可以用这个来管理博客和文档。因为不支持中文搜索，管理博客还是有一些问题的，主要还是用来管理文档的。
简单轻量 智能全文搜索插件 多个主题可选 有用的插件 API 兼容 IE11 支持嵌入文件 mkdocs/mkdocs Stars: 16.7k License: BSD-2-Clause MkDocs...MkDocs 设计易于使用，并可通过第三方主题、插件和 Markdown 扩展来定制功能。 以下是该项目的关键特性和核心优势： 从 Markdown 文件中构建静态 HTML 文件。...以下是该项目的关键特性和核心优势： 持续集成：当您将代码推送到 GitHub 后，Read the Docs 将自动更新并重新构建您的文档。...强大而灵活：通过结合 reStructuredText 和 Sphinx 的功能，在 Read the Docs 上编写丰富格式化和交互式内容变得更加容易。...多平台适配：无论是在电脑上还是移动设备上浏览您的文档网站都能得到良好呈现。 如果你正在寻找一个方便易用又功能强大的工具来构建静态网站或者在线文档，请考虑尝试 VuePress Next。
本文首发于 Nebula Graph Community 公众号 [如何打造多版本文档中心] 世界上没有完美的产品，每个不完美的产品都需要一份文档。...MkDocs MkDocs 是一个快速、简单、美观的开源静态网站生成器，用于构建项目文档。文档源文件为 Markdown 格式，配置写在 YAML 文件中。...# 版权信息 copyright: Copyright © 2021 Nebula Graph - 浙ICP备20010487号 设置 GitHub 信息 Nebula 文档库托管在 GitHub 上，...自定义 logo 可以使用文档库内的各类型图片，包括但不限于 PNG、SVG 格式，或者外部网络上的图片，作为页面 logo。...版本号自动变更 文档中的版本号有时需要根据版本修改，使用 macros 插件设置宏变量后，只要修改了 mkdocs.yml 文件中的设置，就可以方便地实现文档中的版本号自动变更。
扩展模块同样我也给你准备好了，在你回复「Sphinx」后，获取压缩包后，里面有个 exts 文件夹。你只要将这个文件夹原封不动的放置在与source的同级目录下即可。...这里我将工程文件，托管在GitHub上，然后由Read the Docs发布。 在托管之前呢，我们需要准备工作。...在mkdocs根目录下，添加文件.gitignore（聪明的你，肯定知道这是什么），内容如下 build/ .idea/ *.pyc 接下来，在你的GitHub上新建一个仓库。...然后把mkdocs这个目录下的所有文件都提交上去。步骤很简单，这里就不细讲。 06 发布上线 ---- 托管完成后，我们要发布它，让别人可以访问。...构建网页后。右下方，你可以看见你的在线地址。
更好的是，层可以在多个镜像上共享。拥有高度优化的基本镜像和优化的Dockerfiles可以为您带来难以置信的性能优势。 在Codeship构建期间，使用缓存镜像的能力是至关重要的。...Codeship面临的一个独特的情况是，我们的构建机器是短暂的，这意味着每次运行构建时都会得到一个新机器。没有镜像缓存可以重新使用，因为这些镜像以前从未建立过，在构建过程中，只需要构建一次。...因为构建性能对我们的客户非常重要，所以我们回滚并停留在Docker 1.9.2上以保留缓存系统。...那些保存的Docker镜像可以远程存储，并在构建开始之前下拉。本质上，流程与之前的实现完全相同，只不过存储组件从注册表切换到S3。...透明度 更新我们的缓存系统有很多好处，例如客户不再需要在Codeship构建期间为了缓存而设置私有注册表。
持续交付（CD）实际上是 CI 的扩展，其中软件交付流程进一步自动化，以便随时轻松地部署到生成环境中。 成熟的持续交付方案也展示了一个始终可部署的代码库。...否则，将继续进入下一个测试， 并在连续通过测试后自动进入下一个阶段。流水线的最后一个部分会将构建部署到和生产环境等效的环境中。...CI/CD 系统的最后一步将在构建后的组件/包退出流水线时自动部署。 此类自动部署可以配置为快速向客户分发组件、功能模块或修复补丁，并准确说明当前提供的内容。...除了开源项目之外，还有一些更现代化的商业产品例如 CircleCI，Codeship 和 Shippable。...我们最终选择了 Codeship，我认为我们的选择是正确的， 也感谢 Codeship 团队的支持。 接下来？
使用MkDocs 安装 MkDocs pip install mkdocs 创建项目 执行下面命令就在当前目录下，生成一个 testdocs 文件夹，就是创建的文档项目 mkdocs new testdocs...和主题 pip install sphinx sphinx_rtd_theme 创建项目 创建一个文件夹后，执行命令 sphinx-quickstart 编写文档 修改主题 在conf.py文件中添加这两行代码...在根目录输入命令，即可生成网站构建。...() 里的内容表示菜单的markdown文件的地址，并且也代表了生成后的html文件url。...部署 上传到github 可以你的文档源文件上传到github上，使用 .gitignore 屏蔽 ./build 目录。
GitBook CLI 可以安装在任何支持 Node.js 环境的系统上，使用npm安装即可。...安装完成后，用户可以使用"gitbook"命令来执行各种操作，如创建书籍、编写内容、构建书籍、发布书籍等。...11.Mkdocs star 数 16K+。 MkDocs 是一个简单易用的静态网站生成器，基于 Markdown 文档构建漂亮的 HTML 文档页面。...部署简单，可以将生成的HTML静态页面部署到任何Web服务器上。 使用 MkDocs，您可以快速创建漂亮的文档页面，非常适合技术写作、软件文档、项目文档等。...相比于其他静态网站生成器，Gridsome 的主要优点在于其高度可定制性和灵活性，因为它是基于 Vue.js 构建的，所以您可以使用所有 Vue.js 的功能和插件来定制您的网站。
GitLab允许您在每次提交或推送时触发构建，运行测试和部署代码。您可以在虚拟机，Docker容器或另一台服务器上构建作业。...Travis CI是用于构建和测试项目的CI服务。Travis CI自动检测新提交并推送到GitHub存储库的提交。每次提交新代码后，Travis CI都会构建项目并相应地运行测试。...可以在travis-ci.org上免费应用开源项目。 主页：https://travis-ci.com Codeship ? Codeship是一个托管平台，可多次支持早期和自动发布软件。...许可：甲骨文在收购后未提供Wercker的价格信息。...Buildbot是一个“基于Python的CI框架”，可自动执行编译和测试周期以验证代码更改，然后在每次更改后自动重建并测试树。因此，可以快速查明构建问题。
持续交付（CD）实际上是 CI 的扩展，其中软件交付流程进一步自动化，以便随时轻松地部署到生成环境中。成熟的持续交付方案也展示了一个始终可部署的代码库。...否则，将继续进入下一个测试， 并在连续通过测试后自动进入下一个阶段。流水线的最后一个部分会将构建部署到和生产环境等效的环境中。...CI/CD 系统的最后一步将在构建后的组件/包退出流水线时自动部署。此类自动部署可以配置为快速向客户分发组件、功能模块或修复补丁，并准确说明当前提供的内容。...除了开源项目之外，还有一些更现代化的商业产品例如 CircleCI，Codeship 和 Shippable。...我们最终选择了 Codeship，我认为我们的选择是正确的， 也感谢 Codeship 团队的支持。 接下来？
持续交付（CD）实际上是 CI 的扩展，其中软件交付流程进一步自动化，以便随时轻松地部署到生成环境中。 成熟的持续交付方案也展示了一个始终可部署的代码库。...否则，将继续进入下一个测试， 并在连续通过测试后自动进入下一个阶段。流水线的最后一个部分会将构建部署到和生产环境等效的环境中。...CI/CD 系统的最后一步将在构建后的组件/包退出流水线时自动部署。 此类自动部署可以配置为快速向客户分发组件、功能模块或修复补丁，并准确说明当前提供的内容。...除了开源项目之外，还有一些更现代化的商业产品例如 CircleCI，Codeship 和 Shippable。...我们尝试过 CircleCI，Codeship 和 Shippable， 下面有一个简单的表格，展示了每个工具的一些细节： 我们最终选择了 Codeship，我认为我们的选择是正确的， 也感谢 Codeship
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
云直播
对象存储
腾讯会议
