bitrock website

site bitrock

Este site é uma instância do VuePress com um tema customizado aplicado, você pode ler a documentação oficial para saber como editar o conteúdo ou como funciona o tema.

Requisitos

Você precisa do seguinte software instalado em sua máquina para começar:

• Node.js estável mais recente
• Gerenciador de pacotes Yarn Ambos podem ser instalados via Homebrew em ambientes MacOS e Linux.

Crie um ambiente de desenvolvimento local

Clone o repositório localmente

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

Vá em frente na pasta e instale dependências com Yarn

$ cd bitrock-website && yarn

Inicie o servidor web de desenvolvimento em localhost:8080

$ yarn start

Autoria

O conteúdo é fornecido por meio de arquivos Markdown na pasta ./src , não há editor visual integrado para que eles possam ser criados onde você quiser, mas em ordem. Os componentes Vue são suportados no conteúdo Markdown e pode ser considerado adicionar alguns componentes personalizados para permitir aos autores recursos extras. Os metadados são fornecidos usando a especificação Frontmatter.

Adicionar uma página

Crie uma subpasta no caminho ./src e a seguir crie um arquivo readme.md dentro dela, em cima do arquivo adicione os seguintes dados:

---
layout : Page
---

Exemplo : o arquivo ./src/about-us/readme.md se tornará a página https://bitrock.it/about-us .

Para adicionar uma página no menu de navegação o ./src/.vuepress/config.js deve ser atualizado.

Adicionar uma postagem no blog

Crie uma subpasta no caminho ./src/blog e a seguir crie um arquivo readme.md dentro dela, em cima do arquivo adicione os seguintes dados:

---
title : Hello world!
image : /img/hello.jpg
author : writer
publish : 2018-12-21
layout : Post
category : news
tags :
  - greetings
  - hello
---

Exemplo : o arquivo ./src/blog/hello-world/readme.md se tornará a página https://bitrock.it/blog/hello-world .

As postagens serão exibidas em ordem cronológica invertida (as mais recentes primeiro) na página principal.

Imagens

Imagens de todo o site devem ser adicionadas na pasta ´./src/.vuepress/public/img´. Observe que se você adicionar uma imagem em uma postagem ou pasta de página, ela não poderá ser acessada fora do URL da página usando um caminho relativo.

Não existe um processo de otimização automatizado , então tome cuidado com o tamanho das imagens que você está publicando.

Desenvolvimento

Todos os arquivos de origem de desenvolvimento estão localizados na pasta ./src/.vuepress/theme .

O ./src/.vuepress/public é onde colocar qualquer tipo de ativo que precise estar disponível como recursos estáticos no nível raiz do domínio de implantação. As subpastas serão preservadas.

Plug-ins Vuepress

• @vuepress/plugin-google-analytics fornecendo o ID de monitoramento do Google Analytics, ele injetará nas páginas o código necessário.
• @vuepress/plugin-pwa gera um Services Worker na fase de construção, mapeando todos os ativos estáticos para cache offline. Ele não gerará o webmanifest necessário para acionar as funcionalidades do PWA, que é criado manualmente e servido na pasta pública.
• @vuepress/plugin-back-to-top basta adicionar o botão de seta voltar ao topo depois de rolar um pouco para baixo a partir da janela de visualização inicial.
• @vuepress/nprogress adiciona a barra de progresso no topo das páginas ao carregar novos conteúdos, semelhante ao que acontece no YouTube.

Utilitários JS

A principal dependência aqui é a biblioteca Vue.js que é usada para construir os componentes, todo o resto é Vanilla Javascript.

Utilitários CSS

Estamos usando estas bibliotecas CSS:

• normalize.css faz com que os navegadores renderizem todos os elementos de forma mais consistente e alinhada com os padrões modernos.
• typebase.css um ponto de partida para tipografia web.
• hambúrgueres Menu de hambúrgueres animados em CSS.

Política de ramificação

Este projeto segue uma política de ramificação simples:

• master contém apenas código estável e não deve ser atualizado diretamente
• development onde o código evoluído ou experimental é escrito
• gh-pages onde os arquivos estáticos distribuíveis são implantados, mas ** você deve evitar confirmar/enviar diretamente aqui **

NÃO mescle diretamente development no master ( está bloqueado pelo administrador... ), sempre envie um PR para uma revisão.

Atualizar e implantar

Cada vez que o branch master é atualizado (um commit direto ou um PR mesclado), um novo trabalho do Travis CI é acionado e é composto por estas etapas:

1. instalar dependências
2. Vuepress constrói o site com todos os arquivos relacionados na pasta /dist
3. se a compilação for bem-sucedida, a pasta /dist será implantada nas páginas do GitHub
4. a nova implantação está disponível em bitrock.it

Há um script NPM disponível para implantação manual no branch gh-pages de sua máquina local (você deve primeiro construir o projeto localmente):

$ yarn gh:pages

Mas por favor, use-o apenas se for realmente necessário.

Licença

Os logotipos do Grupo Databiz, Bitrock e Radicalbit são marcas registradas. O código é distribuído sob a licença GNU AGPLv3. As fotos incluídas foram fornecidas pela Unsplash.