快速上手
# 前言
本网站使用Vuepress搭建,vuepress是一个基于Vue的博客系统,支持主题,支持markdown语法。它是Vue.js家族的一员。不得不说,尤大出品,必属精品。但是归根结底,他还是一个静态网站,使用github pages进行部署。那么,我们就要想办法使其拥有后台的效果。那么我们就可以借助github actions持续集成来实现,只要监听到main分支出现了push操作,那么就重新部署静态网站。
为什么使用markdown呢?因为markdown是一种可以轻松地描述文档的语言,而且它的语法比html更加简单,更加灵活,更加易于阅读。并且,它也能兼容html,所以我们可以使用markdown来描述我们的文档。
# 一、创建属于你的文件夹
打开Github项目,在docs/技术文档/下创建一个文件夹,比如Geo,要与 “01.橙子” 同级。
应该在该文件夹的下一级建立文件夹。
注意
注意:必须创建新的文件夹,且署名前面必须存在序号,不允许与之前的同学创建的文件夹的序号相同。
你可以将仓库克隆到本地,然后在本地创建文件夹,然后在本地提交。这样可以直接创建文件夹及文档。但是这
先决条件是你以及部署好了Vue、Node、Git、GitHub等环境。需要一大堆配置才能完成本地预览和coding。
因此我建议,你只需要在Github上指定位置建立自己的文件夹,熟悉本站的Markdown编写模式,即可完成你自己的博客模块。如何在Github建立空文件夹?参考这篇文档 (opens new window),核心要点是你必须创建一个无用的占位文件,然后在文件夹中有实际内容后删除它。
# 二、创建你的第一个Markdown文档
本网站的文档使用的是自动部署。你只要上传md文件之后,稍等几分钟即可看到网站更新。这是怎么实现的?我们下一篇博客见。自动部署,必须要秩序井然。因此在你自己的文件夹中,每一篇笔记也得有他自己的编号。这决定了最终显示的顺序。如果你将项目克隆到了本地,你只需要直接新建markdown文件,它会自动分配文件头。又或者你可以自己建立一个空的markdown文件,然后在文件中写入内容。这时,你必须写入合适的文件头。否则,发生冲突时极易build失败。
---title: 文档站使用指北 #文件名
date: 2022-06-01 20:51:37 #修改时间
permalink: /pages/czh01/ #链接 你只需要将a改成其他的,建议改为你的名字加序号。
categories:
- 快速入手 #分类,随便填
- 使用指南 #分类,随便填
tags:
- vuepress #tag 将显示在文件底部,随便填
author:
name: Chengzihan #你的署名
link: https://github.com/Orangeczh423 #你的github链接
2
3
4
5
6
7
8
9
10
11
提示
你需要学习markdown语法,它很轻量级,只需要简单的掌握。右上角的链接能够帮助你。当然本网站使用的构建模板也提供了部分容器,你也可以使用,比如这条tip。参考这篇文档 (opens new window)
提示
对了,你一定会需要在博客里面插入图片。插入图片是由在markdown文件中插入图片的链接的方法。但是图片放在哪呢?最好不要改变项目结构,所以推荐存储在外链,再通过连接调用,很多托管网站会直接提供链接。推荐的外链图片托管网站:imgloc (opens new window)
# 三、上传日志并检查部署
当你完成了上面的步骤,你的博客文件也就完成了。那么就需要上传到Github了。你可以将你的markdown文件上传到上面建立的文件夹中。
注意
上传完成后你必须检查部署情况。在标签页的Actions即可看到部署进程。部署有三个步骤(fileadd、baidupush、deploy),如下图的示意。如果三项全为绿色,则说明部署成功,如果报错没那么很可能是文件序号或者permalink的问题。刷新网站后即可在技术博客目录看到你的文章。【你只需要检查,不需要做任何操作】
# 结语
如此,你的第一篇博客就完成了。
如果有同学愿意加入公司官网开发行列,实现真后台,我们可以一起探讨!
关于博客的部署,有问题可以问我哦!如果你不想使用github或者经历复杂的部署过程,可以将你的文档发给我。
# 附录
Github Actions持续集成yml配置文件
# name 可以自定义
name: Deploy GitHub Pages
# 触发条件:在 push 到 main 分支后,新的 Github 项目 应该都是 main,而之前的项目一般都是 master
on:
push:
branches:
- main
# 任务
jobs:
build-and-deploy:
# 服务器环境:最新版 Ubuntu
runs-on: ubuntu-latest
steps:
# 拉取代码
- name: Checkout
uses: actions/checkout@v2
with:
persist-credentials: false
# 生成静态文件
- name: Build
run: npm install && npm run build
# 部署到 GitHub Pages
- name: Deploy
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} # 也就是我们刚才生成的 secret
BRANCH: gh-pages # 部署到 gh-pages 分支,因为 main 分支存放的一般是源码,而 gh-pages 分支则用来存放生成的静态文件
FOLDER: docs/.vuepress/dist # vuepress 生成的静态文件存放的地方
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33