vuepress-theme-reco + Github Actions 構建靜態博客,部署到第三方伺服器

来源:https://www.cnblogs.com/Tsanfer/archive/2020/03/22/12546139.html
-Advertisement-
Play Games

"最新博客鏈接" "Github鏈接" 查看此文檔前應先瞭解, "vuepress基本操作" 參考官方文檔進行配置: "vuepress theme reco" "VuePress" "SamKirkland / FTP Deploy Action" 最終效果 "最終效果鏈接" 思路 下載vuepr ...


Build Status Coverage Status

最新博客鏈接

Github鏈接

查看此文檔前應先瞭解,vuepress基本操作

參考官方文檔進行配置:

vuepress-theme-reco

VuePress

SamKirkland / FTP-Deploy-Action

最終效果

最終效果鏈接

思路

下載vuepress-theme-reco官方的主題模板(腳手架),再根據自己的需要進行相應的修改,再根據自己的伺服器配置Github Actions文件,最後上傳到Github,觸發Github Actions自動構建部署到第三方伺服器。以後就只需提交markdown文件到Github,Github Actions便可自動部署到第三方伺服器

用到的東西

  • vuepress-theme-reco

  • VuePress

  • Github Actions

  • SamKirkland / FTP-Deploy-Action

相關

  • vuepress-theme-reco:

    一款簡潔而優雅的 vuepress 博客 & 文檔 主題。

  • Github Actions:

    GitHub 操作 幫助您在您存儲代碼的同一位置自動執行軟體開發工作流程,並協作處理拉取請求和議題。 您可以寫入個別任務,稱為操作,並結合它們創建一個自定義的工作流程。 工作流程是您可以在倉庫中創建的自定義自動化流程,用於在 GitHub 上構建、測試、封裝、發行或部署任何代碼項目。

    通過 GitHub 操作 可直接在倉庫中構建端到端持續集成 (CI) 和持續部署 (CD) 功能。

  • SamKirkland / FTP-Deploy-Action:

    Automate deploying websites and more with this GitHub action

    通過GitHub action自動部署網頁等操作

博客主題配置

快速開始

使用模板

# 初始化
sudo yarn global add @vuepress-reco/theme-cli
theme-cli init my-blog

# 安裝
cd my-blog
sudo yarn install

更改最新依賴

// package.json

{
  "scripts": {
    "dev": "vuepress dev docs",
    "build": "vuepress build docs"
  },
  "dependencies": {
    "vuepress": "^1.4.0",
    "vuepress-theme-reco": "^1.3.2",
    "vuepress-plugin-flowchart": "^1.4.3",
    "@vuepress-reco/vuepress-plugin-bgm-player": "^1.1.2",
    "@vuepress/plugin-nprogress": "^1.4.0",
    "vuepress-plugin-reading-progress": "^1.0.8"
  }
}

然後,安裝依賴

sudo yarn

目錄結構

.
├── .git-ftp-include	// 用於最後指定需要部署的文件或文件夾
├── .gitattributes	// 用於統一文件內編碼的換行符
├── .github
│   └── workflows
│       └── nodejs.yml	// Github Actions的配置文件
├── .gitignore	// 忽略上傳到Github的文件或目錄
├── LICENSE	// 許可證文件
├── README.md	// Github項目展示文件
├── docs	// VuePress項目根目錄
│   ├── .vuepress	// 存放配置文件的文件夾
│   │   ├── config.js	// 整個工程的配置文件
│   │   ├── dist	// 最後生成的文件目錄
│   │   ├── public	// 媒體文件夾(主要是圖片)
│   │   └── styles	// 網頁樣式文件夾(裡面空的,沒有用)
│   ├── README.md	// 網頁首頁文件
│   └── views	// 存放markdown文件的文件夾(可以不要直接把markdown文件放在docs裡面)
│       └── frontEnd	// 分類目錄(也可以不要分類目錄直接放在views裡面)
├── package.json	// 指定依賴,項目腳本,Node.js項目描述文件
├── yarn-error.log	// 記錄構建失敗的日誌文件
└── yarn.lock	// 變更依賴時自動生成和更新

添加博客配置

然後根據需要更改一些內容和設置,參考官方的文檔,可自行取捨相應內容

vuepress-theme-reco

VuePress

// docs/.vuepress/config.js

module.exports = {

  // host: '0.0.0.0',  // 生成網頁地址(本地調試使用)
  // port: '22335',  // 生成網頁埠(本地調試使用)
  title: "Tsanfer's Blog",  // 顯示在左上角的網頁名稱以及首頁在瀏覽器標簽顯示的title名稱
  description: '現居住於獵戶臂上的一個碳基生命',  // meta 中的描述文字,用於SEO
  head: [
    ['link', { rel: 'icon', href: '/favicon.svg' }],  //瀏覽器的標簽欄的網頁圖標,基地址/docs/.vuepress/public
    ['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1,user-scalable=no' }], //在移動端,搜索框在獲得焦點時會放大
  ],

  theme: 'reco',  //選擇主題‘reco’
  themeConfig: {
    type: 'blog', //選擇類型博客
    blogConfig: {
      category: {
        location: 2, // 在導航欄菜單中所占的位置,預設2
        text: '分類' // 預設 “分類”
      },
      tag: {
        location: 3, // 在導航欄菜單中所占的位置,預設3
        text: '標簽' // 預設 “標簽”
      },
    },
    nav: [  //導航欄設置
      { text: '主頁', link: '/', icon: 'reco-home' },
      { text: '時間線', link: '/timeline/', icon: 'reco-date' },
      { text: '聯繫', 
        icon: 'reco-message',
        items: [
          { text: 'GitHub', link: 'https://github.com/Tsanfer', icon: 'reco-github' },
          { text: 'CSDN', link: 'https://blog.csdn.net/qq_27961843/', icon: 'reco-csdn' },
          { text: 'BiliBili', link: 'https://space.bilibili.com/12167681', icon: 'reco-bilibili' },
          { text: 'QQ', link: 'tencent://AddContact/?fromId=50&fromSubId=1&subcmd=all&uin=1124851454', icon: 'reco-qq' },
          { text: 'twitter', link: 'https://twitter.com/a1124851454', icon: 'reco-twitter' },
          { text: 'Gmail', link: 'mailto:[email protected]', icon: 'reco-mail' },
        ]
      }
    ],
    sidebar: 'auto',  //在所有頁面中啟用自動生成側欄
    record: '蜀ICP備20005033號-1',
    startYear: '2020', // 項目開始時間,只填寫年份
    lastUpdated: '最後更新時間', // string | boolean
    author: 'Tsanfer',
    authorAvatar: '/avatar.svg',  //作者頭像
    mode: 'light',  //預設顯示白天模式
    // 評論設置
    valineConfig: {
      appId: process.env.LEANCLOUD_APP_ID,
      appKey: process.env.LEANCLOUD_APP_KEY,
    }
  },

  markdown: {
    lineNumbers: true //代碼顯示行號
  },
  // 搜索設置
  search: true,
  searchMaxSuggestions: 10,

  // 插件
  plugins: [
    ['flowchart'],  // 支持流程圖
    [
      '@vuepress-reco/vuepress-plugin-bgm-player',  // BGM播放器
      {
        audios: [
          {name: 'Faster Than Light',artist: 'Andreas Waldetoft / Mia Stegmar',url: 'https://cdn-image.tsanfer.xyz/music/Andreas%20Waldetoft%2CMia%20Stegmar%20-%20Faster%20Than%20Light.mp3',cover: 'https://p1.music.126.net/Gxv6d9W4Yd9q9WNHPpi8rw==/1379887104073348.jpg'},
          {name: 'Dawn',artist: 'DDRKirby(ISQ)',url: 'https://cdn-image.tsanfer.xyz/music/Dawn%20-%20DDRKirby%28ISQ%29.mp3',cover: 'https://p2.music.126.net/IPnqMCk8YaN9inwYV2bdgQ==/18774161044446693.jpg'},
          {name: 'TRON Legacy (End Titles)',artist: 'Daft Punk',url: 'https://cdn-image.tsanfer.xyz/music/Daft%20Punk%20-%20TRON%20Legacy%20%28End%20Titles%29.mp3',cover: 'https://p2.music.126.net/qOOTIykbSLw9RHB0vI83GA==/737772302281958.jpg'},
          {name: 'Broken Boy',artist: 'Tonspender',url: 'https://cdn-image.tsanfer.xyz/music/Tonspender%20-%20Broken%20Boy.flac',cover: 'https://p2.music.126.net/4TnTRyHqa3-D2H1UnOa00w==/109951163666994621.jpg'},
          {name: 'Life Of Sin Pt. 4',artist: 'MitiS',url: 'https://cdn-image.tsanfer.xyz/music/MitiS%20-%20Life%20Of%20Sin%20Pt.%204.mp3',cover: 'https://p2.music.126.net/LmjTrSwvSLSNBsfFsQFO6g==/2533274793491743.jpg'},
          {name: 'Sea Of Voices (RAC Mix)',artist: 'Porter Robinson',url: 'https://cdn-image.tsanfer.xyz/music/Porter%20Robinson%20-%20Sea%20Of%20Voices%20%28RAC%20Mix%29.mp3',cover: 'https://p1.music.126.net/zjQROkEUokU7iS5eUvnVZQ==/3264450027161111.jpg'},
          {name: 'New Lipstick',artist: 'The Kissaway Trail',url: 'https://cdn-image.tsanfer.xyz/music/The%20Kissaway%20Trail%20-%20New%20Lipstick.flac',cover: 'https://p2.music.126.net/VjN74c1hoYgPCEZ9DngeQw==/109951163772624643.jpg'},
        ],
      },
    ],
    ['vuepress-plugin-smooth-scroll'],  // 平滑滾動
    ['@vuepress/nprogress'],  // 載入進度條
    ['reading-progress']  // 閱讀進度條
  ]
}

Github Actions配置

修改Github Actions配置文件

在Github網頁上添加Github Actions配置文件,參考官方的文檔,可自行取捨相應內容,其中需要保密的部分需要添加Github Secrets環境變數

SamKirkland / FTP-Deploy-Action

# .github/workflows/nodejs.yml

on: push  # 觸發此文件運行的條件
name: Github Actions  # 此工作流程(workflow)的名字
jobs:
  FTP-Deploy-Action:
    name: FTP-Deploy-Action # 此任務(job)的名字
    runs-on: ubuntu-latest  # 運行環境
    steps:
    - uses: actions/checkout@master # 切換分支到master
      with:
        fetch-depth: 2

    - name: Use Node.js 12.x  
      uses: actions/setup-node@v1
      with:
        node-version: '12.x'
        
    - name: Build Project # 此步驟(step)的名字
      run: yarn && yarn build # 下載依賴和構建項目
      env:
        LEANCLOUD_APP_ID: ${{ secrets.LEANCLOUD_APP_ID }} # 評論系統的ID
        LEANCLOUD_APP_KEY: ${{ secrets.LEANCLOUD_APP_KEY }} # 評論系統的KEY

    - name: List output files
      run: ls -a docs/.vuepress/dist # 顯示生成的目錄文件
      
    - name: FTP-Deploy-Action
      uses: SamKirkland/[email protected]
      with:
        ftp-server: sftp://39.107.221.57:22 # 伺服器地址和埠(可以填功能變數名稱,不過我伺服器做了全站加速會導向加速結點的IP,所以只能用伺服器的IP)
        ftp-username: ${{ secrets.FTP_USERNAME }} # FTP用戶名
        ftp-password: ${{ secrets.FTP_PASSWORD }} # FTP密碼
        git-ftp-args: --insecure --remote-root /home/www/htdocs # 要部署到伺服器的哪個位置(我這用的是SFTP,如果是FTP連接的話--insecure不用加)
        local-dir: docs/.vuepress/dist/ # 選擇哪些文件要部署到伺服器,這個選項在這裡選了之後,要在.git-ftp-include中添加相應的路徑
// .git-ftp-include

!docs/.vuepress/dist/

添加Github Token

為了保密,把重要信息用變數表示,在Github Secrets中添加相應的值

倉庫的Settings --> Secrets --> Add a new secret

比如

  • Name: FTP_USERNAME
  • Value: admin

最後再把代碼上傳到Github便可自動觸發構建,部署到第三方伺服器

本文由Tsanfer's Blog 發佈!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 出處:https://www.cnblogs.com/zengyuanjun/p/7429968.html /** * @desc 面向aop編程 * @param {Function} originFunc - 源方法 * @param {Function} before - 在源代碼執行之前的方 ...
  • 冒泡排序和選擇排序 作用和原理 將數組中的數值,按照執行的順序,從小到大排序或者從大到小排序,本文中均為從小到大排序。 冒泡排序 原理: 相鄰的兩個單位,比較存儲的數據,如果第一個單元的數據較大,就將兩個相鄰單元,交換存儲數據 核心: 交換存儲的數據 兩個相鄰的單元,比較數據大小,第一個單元數值較大 ...
  • 大家好,我是逆戰班的一員,今天給大家講解一下Js迴圈中的For迴圈。 For迴圈是JS迴圈中一個非常重要的部分。 我們先講一下for迴圈的作用: For迴圈用在需要重覆執行的某些代碼,比如從1列印到100;或者尋找1到100中的偶數、奇數、質數、合數等等。 然後是For迴圈語句的基本結構: for( ...
  • XSS的中文名稱叫跨站腳本,是WEB漏洞中比較常見的一種,特點就是可以將惡意HTML/JavaScript代碼註入到受害用戶瀏覽的網頁上,從而達到劫持用戶會話的目的。XSS根據惡意腳本的傳遞方式可以分為3種,分別為反射型、存儲型、DOM型,前面兩種惡意腳本都會經過伺服器端然後返回給客戶端,相對DOM ...
  • 一、Overview angular 入坑記錄的筆記第四篇,介紹在 angular 中如何通過 HttpClient 類發起 http 請求,從而完成與後端的數據交互。 對應官方文檔地址: "Angular HttpClient" 配套代碼地址: "angular practice/src/http ...
  • 在網頁上找了半天,發現現在的資源實在是少的可憐,而前端尤甚。所以沒辦法,於是自己花了一些時間寫了一個; 1 /** 2 * 刪除URL中的指定參數 3 * @param {*} url 4 * @param {*} name 5 */ 6 function delUrlParams(url, nam ...
  • 今天學習node的時候連接mysql報了這麼一個錯誤: MySQL 8.0 Client does not support authentication protocol requested by server; consider upgrading MySQL client, 這麼一長條我也看不懂 ...
  • 作者:Filip Rakowski 翻譯:啟道學院 我們已經知道,在Vue的新版本中編寫的應用程式將表現得非常好,但性能並不是最重要的部分。 對我們開發人員來說最重要的是新版本將如何影響我們編寫代碼的方式。 正如你所預料的,Vue3帶來了許多新的振奮人心的功能。 幸運的是,Vue團隊主要對當前的Co ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...