bitrock website

sitio web bitrock

Este sitio web es una instancia de VuePress con un tema personalizado aplicado. Puede leer la documentación oficial para aprender cómo editar contenidos o cómo funciona el tema.

Requisitos

Necesita el siguiente software instalado en su máquina para poder comenzar:

• Node.js último estable
• Administrador de paquetes Yarn Ambos se pueden instalar a través de Homebrew en entornos MacOS y Linux.

Crear un entorno de desarrollo local

Clonar el repositorio localmente

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

Vaya a la carpeta e instale las dependencias con Yarn

$ cd bitrock-website && yarn

Inicie el servidor web de desarrollo en localhost:8080

$ yarn start

Autoría

El contenido se proporciona a través de archivos Markdown en la carpeta ./src , no hay un editor visual incorporado, por lo que se pueden crear donde quieras, pero en orden. Los componentes de Vue son compatibles con el contenido de Markdown y se puede considerar agregar algunos componentes personalizados para permitir a los autores capacidades adicionales. Los metadatos se proporcionan utilizando la especificación Frontmatter.

Añadir una página

Cree una subcarpeta en la ruta ./src y luego cree un archivo readme.md dentro de ella, encima del archivo agregue los siguientes datos:

---
layout : Page
---

Ejemplo : el archivo ./src/about-us/readme.md se convertirá en la página https://bitrock.it/about-us .

Para agregar una página en el menú de navegación, se debe actualizar ./src/.vuepress/config.js .

Agregar una publicación de blog

Cree una subcarpeta en la ruta ./src/blog y luego cree un archivo readme.md dentro de ella, encima del archivo agregue los siguientes datos:

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

Ejemplo : el archivo ./src/blog/hello-world/readme.md se convertirá en la página https://bitrock.it/blog/hello-world .

Las publicaciones se mostrarán en orden cronológico inverso (las más recientes primero) en la página principal.

Imágenes

Las imágenes de todo el sitio deben agregarse en la carpeta ´./src/.vuepress/public/img´. Tenga en cuenta que si agrega una imagen dentro de una publicación o carpeta de página, no será accesible fuera de la URL de la página mediante una ruta relativa.

No existe un proceso de optimización automatizado , así que tenga cuidado con el tamaño de las imágenes que publica.

Desarrollo

Todos los archivos fuente de desarrollo se encuentran dentro de la carpeta ./src/.vuepress/theme .

El ./src/.vuepress/public es el lugar donde colocar cualquier tipo de activo que deba estar disponible como recursos estáticos en el nivel raíz del dominio de implementación. Se conservarán las subcarpetas.

Complementos de Vuepress

• @vuepress/plugin-google-analytics proporciona el ID de monitoreo de Google Analytics, inyectará en las páginas el código requerido.
• @vuepress/plugin-pwa genera un trabajador de servicios en la fase de compilación que asigna todos los activos estáticos para el almacenamiento en caché sin conexión. No generará el manifiesto web necesario para activar las funcionalidades de PWA, que se crea manualmente y se entrega en la carpeta pública.
• @vuepress/plugin-back-to-top simplemente agrega el botón de flecha hacia arriba después de desplazarse un poco hacia abajo desde la ventana gráfica inicial.
• @vuepress/nprogress agrega la barra de progreso en la parte superior de las páginas al cargar contenido nuevo, similar a lo que sucede en YouTube.

Utilidades JS

La dependencia principal aquí es la biblioteca Vue.js que se utiliza para construir los componentes, todo lo demás es Vanilla Javascript.

Utilidades CSS

Estamos usando estas bibliotecas CSS:

• normalize.css hace que los navegadores muestren todos los elementos de manera más consistente y acorde con los estándares modernos.
• typebase.css un punto de partida para la tipografía web.
• hamburguesas Menú de hamburguesas animado con CSS.

Política de ramificación

Este proyecto sigue una política de ramificación simple:

• master contiene solo código estable y no debe actualizarse directamente
• development donde se escribe código evolucionado o experimental.
• gh-pages donde se implementan los archivos estáticos distribuibles, pero ** debes evitar confirmar/enviar directamente aquí **

NO fusione directamente development con master ( está bloqueado por el administrador... ), envíe siempre un PR para realizar una revisión.

Actualizar e implementar

Cada vez que se actualiza la rama master (una confirmación directa o un PR combinado), se activa un nuevo trabajo de Travis CI y se compone de estos pasos:

1. instalar dependencias
2. Vuepress crea el sitio web con todos los archivos relacionados en la carpeta /dist
3. Si la compilación se realiza correctamente, la carpeta /dist se implementa en las páginas de GitHub.
4. la nueva implementación está disponible en bitrock.it

Hay un script NPM disponible para implementar manualmente en la rama gh-pages desde su máquina local (primero debe compilar el proyecto localmente):

$ yarn gh:pages

Pero úselo sólo si es realmente necesario.

Licencia

Los logotipos de Databiz Group, Bitrock y Radicalbit son marcas registradas. El código se distribuye bajo la licencia GNU AGPLv3. Las fotografías de archivo incluidas fueron proporcionadas por Unsplash.