bitrock website

BitRock-Website

このWebサイトは、カスタムテーマが適用されているVuePressインスタンスです。公式ドキュメントを読んで、コンテンツの編集方法やテーマの仕組みを学ぶことができます。

必要条件

開始するには、次のソフトウェアがマシンにインストールされている必要があります。

• node.js最新の安定性
• Yarnパッケージマネージャーは両方とも、MacOS＆Linux環境でHomeBrewを介してインストールできます。

ローカル開発環境を作成します

リポジトリをローカルにクローンします

$ git clone [email protected]:bitrockteam/bitrock-website.git

フォルダーを移動し、糸で依存関係をインストールします

$ cd bitrock-website && yarn

localhost:8080で開発Webサーバーを開始します

$ yarn start

オーサリング

コンテンツは、 ./srcフォルダー内のMarkDownファイルを介して提供されます。ビルトインVisual Editorはありませんので、どこにでも作成できますが、順番に作成できます。 VueコンポーネントはMarkdownコンテンツ内でサポートされており、追加の機能を備えた著者を有効にするために、いくつかのカスタムコンポーネントを追加すると考える場合があります。メタデータは、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 themeフォルダー内にあります。

./src/.vuepress/publicは、展開ドメインのルートレベルで静的リソースとして利用できるようにする必要があるあらゆる種類の資産を配置する場所です。サブフォルダーは保存されます。

Vuepressプラグイン

• @vuepress/plugin-google-analytics Googleアナリティクス監視IDを提供すると、必要なコードをページに挿入します。
• @vuepress/plugin-pwaオフラインキャッシュ用のすべての静的資産をマッピングするビルドフェーズでサービスワーカーを生成します。 PWA関数をトリガーするために必要なWebマニフェストは生成されません。PWA機能は手動で作成され、パブリックフォルダーで提供されます。
• @vuepress/plugin-back-to-top最初のビューポートから少しスクロールした後、バックを上矢印ボタンに追加するだけです。
• @vuepress/nprogress YouTubeで起こることと同様に、新しいコンテンツをロードするときに、ページの上部に進行状況バーを追加します。

JSユーティリティ

ここでの主な依存関係は、コンポーネントの構築に使用されるVue.JSライブラリです。他のすべてはVanilla JavaScriptです。

CSSユーティリティ

このCSSライブラリを使用しています。

• remormize.cssは、ブラウザにすべての要素をより一貫して最新の標準に合わせてレンダリングするようにします。
• Theptbase.css Webタイポグラフィの出発点。
• ハンバーガーCSSアニメーションハンバーガーメニュー。

Branching policy

This project follows a simple branching policy:

• master contains only stable code, and should not be updated directly
• 進化したまたは実験コードが書かれているdevelopment
• 分散型静的ファイルが展開されているgh-pagesですが、**ここで直接コミット/プッシュすることを避ける必要があります**

Do NOT merge directly development into master ( it's admin-locked... ), always send a PR to have a review.

更新および展開

masterブランチが更新されるたびに（直接コミットまたはマージされたPR）、新しいTravis CIジョブがトリガーされ、これらの手順で構成されています。

1. 依存関係をインストールします
2. vuepressは、すべての関連ファイルを/distフォルダーでWebサイトを構築します
3. ビルドが成功した場合、 /distフォルダーはgithubページに展開されます
4. 新しい展開はBitRock.itで利用できます

gh-pagesブランチにローカルマシンから手動で展開できるNPMスクリプトがあります（最初にプロジェクトをローカルで構築する必要があります）。

$ yarn gh:pages

ただし、本当に必要な場合にのみ使用してください。

ライセンス

Databizグループ、BitRock、およびRadicalbitロゴは、登録商標です。コードはGNU AGPLV3ライセンスの下で配布されます。含まれているストック写真は、Unsplashによって提供されています。