bitrock website
v2.0.0 - VuePress
Ce site Web est une instance de VuePress avec un thème personnalisé appliqué, vous pouvez lire la documentation officielle pour savoir comment modifier le contenu ou comment fonctionne le thème.
Vous avez besoin du logiciel suivant installé sur votre ordinateur pour commencer :
Cloner le dépôt localement
$ git clone [email protected]:bitrockteam/bitrock-website.gitDéplacez-vous sur le dossier et installez les dépendances avec Yarn
$ cd bitrock-website && yarn Démarrez le serveur Web de développement sur localhost:8080
$ yarn start Le contenu est fourni via des fichiers Markdown dans le dossier ./src , il n'y a pas d'éditeur visuel intégré, vous pouvez donc les créer où vous le souhaitez, mais dans l'ordre. Les composants Vue sont pris en charge dans le contenu Markdown et il peut être envisagé d'ajouter des composants personnalisés pour permettre aux auteurs de bénéficier de fonctionnalités supplémentaires. Les métadonnées sont fournies à l'aide de la spécification Frontmatter.
Créez un sous-dossier dans le chemin ./src , puis créez un fichier readme.md à l'intérieur, au-dessus du fichier, ajoutez les données suivantes :
---
layout : Page
--- Exemple : le fichier ./src/about-us/readme.md deviendra la page https://bitrock.it/about-us .
Pour ajouter une page dans le menu de navigation, le ./src/.vuepress/config.js doit être mis à jour.
Créez un sous-dossier dans le chemin ./src/blog , puis créez un fichier readme.md à l'intérieur, au-dessus du fichier, ajoutez les données suivantes :
---
title : Hello world!
image : /img/hello.jpg
author : writer
publish : 2018-12-21
layout : Post
category : news
tags :
- greetings
- hello
--- Exemple : le fichier ./src/blog/hello-world/readme.md deviendra la page https://bitrock.it/blog/hello-world .
Les messages seront affichés par ordre chronologique inversé (le dernier en premier) sur la page principale.
Les images à l’échelle du site doivent être ajoutées dans le dossier « ./src/.vuepress/public/img ». Notez que si vous ajoutez une image dans un dossier de publication ou de page, elle ne sera pas accessible en dehors de l'URL de la page à l'aide d'un chemin relatif.
Il n'existe pas de processus d'optimisation automatisé , alors soyez prudent sur la taille des images que vous publiez.
Tous les fichiers sources de développement se trouvent dans le dossier ./src/.vuepress/theme .
Le ./src/.vuepress/public est l'endroit où placer tout type d'actifs qui doivent être disponibles en tant que ressources statiques au niveau racine du domaine de déploiement. Les sous-dossiers seront conservés.
La dépendance principale ici est la bibliothèque Vue.js qui est utilisée pour construire les composants, tout le reste est Vanilla Javascript.
Nous utilisons ces bibliothèques CSS :
Ce projet suit une politique de branchement simple :
master ne contient que du code stable et ne doit pas être mis à jour directementdevelopment où du code évolué ou expérimental est écritgh-pages où les fichiers statiques distribuables sont déployés mais ** vous devriez éviter de valider/pousser directement ici ** Ne fusionnez PAS directement development dans master ( il est verrouillé par l'administrateur... ), envoyez toujours un PR pour avoir un examen.
Chaque fois que la branche master est mise à jour (un commit direct ou un PR fusionné), un nouveau travail Travis CI est déclenché et composé de ces étapes :
/dist/dist est ensuite déployé sur les pages GitHub Un script NPM est disponible pour être déployé manuellement dans la branche gh-pages à partir de votre machine locale (vous devez d'abord créer le projet localement) :
$ yarn gh:pagesMais veuillez ne l’utiliser que si cela est vraiment nécessaire.
Les logos Databiz Group, Bitrock et Radicalbit sont des marques déposées. Le code est distribué sous la licence GNU AGPLv3. Les photos d’archives incluses ont été fournies par Unsplash.
