Skip to content

Blog Deployment

使用Sphinx 和 Readthedocs部署博客

  • 基本步骤概览
# launch anaconda prompt (anaconda3)
conda install sphinx
sphinx-quickstart
make html # sphinx-build -b html sourcedir builddir
# github端， 加 webhook

# Github 端操作
Payload URL: https://readthedocs.org/api/v2/webhook/iusl-test/95088/
select:
branch or tag creation
branch or tag deletion
pushes
Active

# readthedocs 设置
Cpython 解释器： CPython3.x
Python 配置文件： source/conf.py

  • 问题 cannot import name 'PackageFinder' from 'pip._internal.index'”

  • 问题 contents.rst not found

  • md 和 rst 共存

    • https://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rst

使用Mkdoc和Github部署个人博客

参考资料

  • 英文原版 https://www.mkdocs.org/user-guide/deploying-your-docs/
  • 中文版，有些不一样 https://markdown-docs-zh.readthedocs.io/zh_CN/latest/#_11
  • https://edgarroman.github.io/techtalk-mkdocs/

环境准备

  • 安装python

  • 下载 get-pip.py， 用于安装pip

  • 安装pip (一个软件包管理系统，用Python写成)

bash python get-pip.py

  • 安装mkdoc

bash pip install mkdocs

  • 初始化第一个项目

bash mkdocs new my-project cd my-project

  • 在yaml 的同级目录下

BASH mkdocs serve

  • 用浏览器打开 http://127.0.0.1:8000/ 就可以看到第一个本地网站

  • build the site

  • mkdocs build

cmd 环境变量设置

在windows系统中安装好Git 和 Python 之后，当直接打开cmd 使用python 或者 git命令的时候，可能会出现命令无法识别的问题。此时需要添加环境变量。什么是环境变量呢？

环境变量（environment variables）一般是指在操作系统中用来指定操作系统运行环境的一些参数。环境变量是在操作系统中一个具有特定名字的对象，它包含了一个或者多个应用程序所将使用到的信息。例如Windows和DOS操作系统中的path环境变量，当要求系统运行一个程序而没有告诉它程序所在的完整路径时，系统除了在当前目录下面寻找此程序外，还应到path中指定的路径去找。

具体设置环境变量的步骤是：

  • 在windows系统中，打开控制面板，选择系统
  • 再选择高级系统设置，选择环境变量，在系统变量一栏里选择新建
  • 变量名：Path
  • 变量值： E:\Git\Git\bin;E:\Anaconda3\Scripts;E:\Anaconda3;E:\Git\Git\mingw64\bin， 注意有多个路径时，用分号隔开

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.
  • pip install -U mkdocs to upgrade mkdocs

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

注意事项

  • 单个网页内部跳转的标签必须为小写, 而且没有空格

    markdown [Back to Top](#frontier2019)

  • 插入图片的时候，如果需要调整大小，则图片文件夹前面必须加上斜杠 /

    html <img src = '/fig/20200129232456.gif' width=250>

  • 如果更换了theme, 发现 version collision, 则先卸载该theme, 再重新安装，原因是 mkdocs 更新了，然后主题也得更新。

    bash pip uninstall mkdocs-material pip install mkdocs-material

  • Bug： 代码块 ``` 如果有缩进，那么在网页上会出现混乱， 至于顶格即可

使用Hexo和GitHub部署个人博客

参考资料

  • https://juejin.im/post/5a6ee00ef265da3e4b770ac1
  • https://juejin.im/post/5bebfe51e51d45332a456de0

简要摘记

已经熟悉全部流程后的简要摘记

cd G:
cd hexoBlog

hexo init
npm install

hexo new "My New Post"  # Create a new post

hexo server  # Run server
http://localhost:4000/   # check server

hexo g   # g=generate, Generate static files
hexo d   # d=deploy, Deploy to remote sites

环境准备

  • 下载并安装 Node.js

  • 下载并安装 Git

  • 安装Hexo , 打开GitBash,

npm install hexo-cli -g

初始化Hexo

  • cd 到想要放置网站文件的文件夹

bash cd g: mkdir -p hexoBlog cd hexoBlog

  • 初始化文件夹

bash hexo init npm install

  • 文件加说明
  • _config.yml： 其中我们以后的大部分操作都会在_config.yml中进行，这个文件是我们的站点的配置文件。
  • scaffolds： 脚手架模板文件，规定了我们创建一篇文章的时候最开始的样子，
  • source： 可以暂时的理解成我们文章的存放处
  • themes： 主题文件
  • 启动服务器， hexo server，并且打开http://localhost:4000/即可查看初始的本地版本

部署到Github

  • 去GitHub 建立一个新的仓库(repository)

  • repo的名字一定要满足 .github.io， 只有这样的仓库名称最后才能以静态页面展示：

  • 安装hexo-deployer-git插件

bash npm install hexo-deployer-git --save

  • 添加SSH key，已经有的话可以跳过此步骤

  • 创建一个 SSH key 。在命令行（即Git Bash）输入以下命令, 回车即可

    bash ssh-keygen -t rsa -C "邮箱地址"

  • 添加到 github。 复制密钥文件内容（路径形如C:\Users\Administrator\.ssh\id_rsa.pub），粘贴到New SSH Key即可。

  • 测试是否添加成功。在命令行（即Git Bash）依次输入以下命令，返回“You've successfully authenticated”即成功：

    bash ssh -T git@github.com yes

  • 修改_config.yml（在站点目录下）。文件末尾修改为：

bash # Deployment ## Docs: https://hexo.io/docs/deployment.html deploy: type: git repo: git@github.com:<Github账号名称>/<Github账号名称>.github.io.git branch: master

  • ==注意：上面仓库地址写ssh地址，不写http地址。==

  • 推送到GithubPages

bash hexo g # g=generate hexo d # d=deploy

  • 等待1分钟左右，浏览器访问网址： https://<Github账号名称>.github.io

新建文章

  • 使用命令 hexo new post “文章名字” 就可新建文章，
  • 建立好的文章在 source/_posts中，编辑完成后执行第三步中终端的操作就可以啦，刷新下浏览器就可看到你的新文章mmm