docslikecode

Docs comme le code

Le site Web

Ce site Web est destiné à offrir des histoires et des articles sur la façon de traiter les documents comme le code et les leçons apprises en cours de route. Vous êtes également invités à raconter votre histoire ici.

Pour contribuer

Vous pouvez soumettre directement une demande de traction à l'aide du workflow Fork and-Pull pour ajouter un article, ou soumettre au repo JustWriteClick / Docs-Code-Code si vous souhaitez suivre un modèle de questions-réponses.

Pousser vers la branche build vous permet de prévisualiser la sortie de build à l'aide de NetLify. Vous devez vous connecter à Netlify pour afficher le déploiement de l'aperçu.

Pousser vers la branche main construit la sortie sur https://www.docslikcode.com à l'aide de NetLify. La publication automatique est en tant que paramètre dans Netlify, donc les déploiements de main sont publiés automatiquement.

Thème colophon

Thème gracieuseté de https://mmistakes.github.io/so-simple-theme/

Pour construire localement (macOS)

Testez vos ajouts et modifiez le contenu en exécutant une version locale.

Sur MacOS, vous devez installer Brew, Bundler.io et Ruby Version Manager afin que vous puissiez utiliser une version particulière de Ruby:

1. Utilisez Brew pour installer un gestionnaire de version Ruby.

    $ brew install rbenv ruby-build
   

2. Ajoutez RBENV à bash pour qu'il se charge à chaque fois que vous ouvrez un terminal. Si vous utilisez MacOS Catalina, votre fichier de profil peut être .zshrc .

    $ echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
   

   ou

    $ echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.zshrc
   

3. Sourcez votre fichier .bash_profile . Si vous utilisez MacOS Catalina, votre fichier de profil peut être .zshrc .

    $ source ~/.bash_profile
   

   ou

    $ source ~/.zshrc
   

4. Installez la version Ruby requise:

    $ rbenv install 2.7.1
   $ rbenv global 2.7.1
   $ rbenv version
   

   En retour, vous devriez voir ruby 2.7.1 2.7.1 (set by /Users/username/docslikecode/.ruby-version .

5. Exécutez gem install bundle pour installer le Gem Bundler, qui aide les dépendances Ruby.

6. Exécutez bundle install la première fois que vous êtes dans le répertoire docslikecode .

Pour construire localement: une fois que vous avez terminé la préparation de votre environnement, vous pouvez construire localement et consulter le site dans votre navigateur.

1. Exécutez la commande Serve.

    $ bundle exec jekyll serve
   

2. Utilisez l'URL d'adresse du serveur http://127.0.0.1:4000/ dans un navigateur pour prévisualiser le contenu.

3. Appuyez sur Ctrl+C dans le terminal de service pour arrêter le serveur.

Conseil
Laissez le terminal de service ouvert et en cours d'exécution. Chaque fois que vous enregistrez des modifications dans un fichier, il régénère automatiquement le site afin que vous puissiez tester la sortie immédiatement. Le seul fichier où les modifications nécessitent un redémarrage est le fichier _config.yml .