bitrock website

битрок-сайт

Этот веб-сайт представляет собой экземпляр VuePress с примененной к нему пользовательской темой. Вы можете прочитать официальную документацию, чтобы узнать, как редактировать содержимое или как работает тема.

Реквизиты

Для начала работы на вашем компьютере должно быть установлено следующее программное обеспечение:

• Последняя стабильная версия Node.js
• Менеджер пакетов Yarn Оба могут быть установлены через Homebrew в средах MacOS и Linux.

Создайте локальную среду разработки

Клонировать репо локально

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

Перейдите в папку и установите зависимости с помощью Yarn.

$ cd bitrock-website && yarn

Запустите веб-сервер разработки на localhost:8080

$ yarn start

Авторская работа

Содержимое предоставляется через файлы Markdown в папке ./src , встроенного визуального редактора нет, поэтому их можно создавать где угодно, но по порядку. Компоненты 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 .

./src/.vuepress/public — это место, куда можно поместить любые ресурсы, которые должны быть доступны в качестве статических ресурсов на корневом уровне домена развертывания. Подпапки сохранятся.

Плагины Vuepress

• @vuepress/plugin-google-analytics, указав идентификатор мониторинга Google Analytics, внедрит на страницы необходимый код.
• @vuepress/plugin-pwa генерирует Service Worker на этапе сборки, отображая все статические ресурсы для автономного кэширования. Он не будет создавать веб-манифест, необходимый для запуска функций PWA, который создается вручную и хранится в общей папке.
• @vuepress/plugin-back-to-top просто добавляет кнопку со стрелкой назад вверх после небольшой прокрутки вниз от исходного окна просмотра.
• @vuepress/nprogress добавляет индикатор выполнения поверх страниц при загрузке нового контента, аналогично тому, что происходит на YouTube.

JS-утилиты

Основная зависимость здесь — это библиотека Vue.js, которая используется для сборки компонентов, все остальное — Vanilla Javascript.

CSS-утилиты

Мы используем следующие библиотеки CSS:

• Normalize.css позволяет браузерам отображать все элементы более последовательно и в соответствии с современными стандартами.
• typebase.css — отправная точка для веб-типографики.
• гамбургеры CSS-анимированное меню гамбургеров.

Политика разветвления

Этот проект следует простой политике ветвления:

• master содержит только стабильный код и не должен обновляться напрямую.
• development при которой пишется усовершенствованный или экспериментальный код
• gh-pages , на которых развернуты распространяемые статические файлы, но ** вам следует избегать прямой фиксации/отсылки сюда**

НЕ объединяйте development напрямую с master ( она заблокирована администратором... ), всегда отправляйте PR для проверки.

Обновление и развертывание

Каждый раз, когда обновляется master ветка (прямая фиксация или объединенный PR), запускается новое задание Travis CI, состоящее из следующих шагов:

1. установить зависимости
2. Vuepress создает веб-сайт со всеми связанными файлами в папке /dist
3. если сборка прошла успешно, папка /dist затем развертывается на страницах GitHub.
4. новое развертывание доступно на bitrock.it

Существует сценарий NPM, который можно развернуть вручную в ветке gh-pages с вашего локального компьютера (сначала необходимо собрать проект локально):

$ yarn gh:pages

Но используйте его только в том случае, если это действительно необходимо.

Лицензия

Логотипы Databiz Group, Bitrock и Radicalbit являются зарегистрированными товарными знаками. Код распространяется по лицензии GNU AGPLv3. Включенные стоковые фотографии предоставлены Unsplash.