該網站是一個應用了自訂主題的 VuePress 實例,您可以閱讀官方文件來了解如何編輯內容或主題如何運作。
您需要在電腦中安裝以下軟體才能開始使用:
將儲存庫克隆到本地
$ git clone [email protected]:bitrockteam/bitrock-website.git
移動資料夾並使用 Yarn 安裝依賴項
$ cd bitrock-website && yarn
在localhost:8080
上啟動開發網路伺服器
$ yarn start
內容透過./src
資料夾中的 Markdown 檔案提供,沒有內建的視覺化編輯器,因此可以在您想要的任何地方按順序編寫它們。 Markdown 內容支援 Vue 元件,可以考慮添加一些自訂元件以使作者俱有額外的功能。元資料是使用 Frontmatter 規範提供的。
在./src
路徑中建立一個子資料夾,然後在其中建立一個readme.md
文件,在文件頂部新增以下資料:
---
layout : Page
---
範例: ./src/about-us/readme.md
檔案將成為https://bitrock.it/about-us
頁面。
若要在導覽功能表中新增頁面,必須更新./src/.vuepress/config.js
。
在./src/blog
路徑中建立一個子資料夾,然後在其中建立readme.md
文件,在文件頂部新增以下資料:
---
title : Hello world!
image : /img/hello.jpg
author : writer
publish : 2018-12-21
layout : Post
category : news
tags :
- greetings
- hello
---
範例: ./src/blog/hello-world/readme.md
檔案將成為https://bitrock.it/blog/hello-world
頁面。
貼文將按時間倒序顯示(最新的在前)在主頁上。
網站範圍的圖像必須加入到“./src/.vuepress/public/img”資料夾中。請注意,如果您在貼文或頁面資料夾中新增圖像,則無法使用相對路徑在頁面 URL 之外存取該圖像。
沒有自動優化過程,因此請注意您要發布的圖像的大小。
所有開發原始檔都位於./src/.vuepress/theme
資料夾中。
./src/.vuepress/public
是放置需要在部署域的根層級上作為靜態資源使用的任何類型的資產的位置。子資料夾將被保留。
這裡的主要依賴項是用於建立元件的 Vue.js 函式庫,其他一切都是 Vanilla Javascript。
我們正在使用這個 CSS 函式庫:
該專案遵循簡單的分支策略:
master
僅包含穩定程式碼,不應直接更新development
gh-pages
部署了可分發的靜態文件,但 ** 您應該避免直接在此處提交/推送**不要直接將development
合併到master
(它是管理員鎖定的... ),始終發送 PR 進行審查。
每次master
分支更新(直接提交或合併 PR)時,都會觸發新的 Travis CI 作業,它由以下步驟組成:
/dist
資料夾中的所有相關文件建立網站/dist
資料夾將部署在 GitHub Pages 上有一個 NPM 腳本可用於從本機電腦手動部署到gh-pages
分支(您必須先在本機建置專案):
$ yarn gh:pages
但請僅在確實需要時使用它。
Databiz Group、Bitrock 和 Radicalbit 標誌是註冊商標。代碼根據 GNU AGPLv3 許可證分發。包含的庫存照片由 Unsplash 提供。