docslikecode

Документы, такие как код

Сайт

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

Чтобы внести свой вклад

Вы можете непосредственно отправить запрос на притяжение, используя рабочий процесс вилки и удара, чтобы добавить статью, или отправить в репо-игры JustWriteClick/Docs-Code Stories, если вы хотите следовать шаблону вопросов и ответов.

Нажатие к филиалу build позволяет предварительно просмотреть выход сборки с помощью NetLify. Вы должны войти в NetLify, чтобы просмотреть развертывание предварительного просмотра.

Нажатие к main ветви строит выход на https://www.docslikecode.com с использованием netlify. Auto Publishing включена в качестве настройки NetLify, поэтому развертывание из main публикуется автоматически.

Тема Колофон

Тема предоставлена ​​https://mmistakes.github.io/so-simple-theme/

Построить локально (macO)

Проверьте свои дополнения и изменения в контенте, запустив локальную сборку.

В MacOS вам нужно установить Bruntler.io и Ruby Version Manager, чтобы вы могли использовать определенную версию Ruby:

1. Используйте Brew, чтобы установить Ruby Version Manager.

    $ brew install rbenv ruby-build
   

2. Добавьте Rbenv в Bash, чтобы он загружался каждый раз, когда вы открываете терминал. Если вы используете MacOS Catalina, ваш файл профиля может быть .zshrc .

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

   или

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

3. Составьте свой файл .bash_profile . Если вы используете MacOS Catalina, ваш файл профиля может быть .zshrc .

    $ source ~/.bash_profile
   

   или

    $ source ~/.zshrc
   

4. Установите требуемую версию Ruby:

    $ rbenv install 2.7.1
   $ rbenv global 2.7.1
   $ rbenv version
   

   В свою очередь, вы должны увидеть ruby 2.7.1 2.7.1 (set by /Users/username/docslikecode/.ruby-version .

5. Запустите gem install bundle , чтобы установить драгоценный камень Bundler, который помогает с зависимостями Ruby.

6. Запустите bundle install в первый раз, когда вы находитесь в каталоге docslikecode .

Чтобы построить локально: как только вы закончите подготовку окружающей среды, вы можете построить локально и просмотреть сайт в своем браузере.

1. Запустите команду подачи.

    $ bundle exec jekyll serve
   

2. Используйте URL -адрес адреса сервера http://127.0.0.1:4000/ в браузере для предварительного просмотра контента.

3. Нажмите Ctrl+C в терминале обслуживания, чтобы остановить сервер.

Кончик
Оставьте терминал подачи открытым и работающим. Каждый раз, когда вы сохраняете изменения в файле, он автоматически восстанавливает сайт, чтобы вы могли немедленно проверить выход. Единственный файл, в котором изменения требует перезапуска, - это файл _config.yml .