bitrock website

Bitrock 网站

该网站是一个应用了自定义主题的 VuePress 实例，您可以阅读官方文档来了解如何编辑内容或主题如何工作。

必备条件

您需要在计算机中安装以下软件才能开始使用：

• Node.js 最新稳定版
• Yarn 包管理器 两者都可以通过 Homebrew 在 MacOS 和 Linux 环境中安装。

创建本地开发环境

将存储库克隆到本地

$ 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是放置需要在部署域的根级别上作为静态资源使用的任何类型资产的位置。子文件夹将被保留。

Vuepress 插件

• @vuepress/plugin-google-analytics提供 Google Analytics 监控 ID，它将在页面中注入所需的代码。
• @vuepress/plugin-pwa它会在构建阶段生成一个服务工作线程，映射所有静态资产以进行离线缓存。它不会生成触发 PWA 功能所需的 webmanifest，该功能是手动编写并在公共文件夹中提供的。
• @vuepress/plugin-back-totop它只是在从初始视口向下滚动一点后添加返回顶部箭头按钮。
• @vuepress/nprogress在加载新内容时在页面顶部添加进度条，类似于 YouTube 中发生的情况。

JS 实用程序

这里的主要依赖项是用于构建组件的 Vue.js 库，其他一切都是 Vanilla Javascript。

CSS 实用程序

我们正在使用这个 CSS 库：

• Normalize.css 使浏览器渲染所有元素更加一致并符合现代标准。
• typebase.css 是网页排版的起点。
• hamburgers CSS 动画汉堡菜单。

分行政策

该项目遵循简单的分支策略：

• master仅包含稳定代码，不应直接更新
• 编写进化或实验代码的development
• gh-pages部署了可分发的静态文件，但是 ** 您应该避免直接在此处提交/推送**

不要直接将development合并到master中（它是管理员锁定的... ），始终发送 PR 进行审查。

更新和部署

每次master分支更新（直接提交或合并 PR）时，都会触发一个新的 Travis CI 作业，它由以下步骤组成：

1. 安装依赖项
2. Vuepress 使用/dist文件夹中的所有相关文件构建网站
3. 如果构建成功， /dist文件夹将部署在 GitHub Pages 上
4. 新部署可在 bitrock.it 上获取

有一个 NPM 脚本可用于从本地计算机手动部署到gh-pages分支中（您必须首先在本地构建项目）：

$ yarn gh:pages

但请仅在确实需要时使用它。

执照

Databiz Group、Bitrock 和 Radicalbit 徽标是注册商标。代码根据 GNU AGPLv3 许可证分发。包含的库存照片由 Unsplash 提供。