docslikecode

像代碼這樣的文檔

網站

該網站旨在提供有關如何像代碼一樣處理文檔以及一路上學到的經驗的故事和文章。歡迎您在這裡講您的故事。

做出貢獻

您可以使用叉式工作流直接提交拉動請求，以添加文章，或者如果要遵循問答模板，則可以提交給JustWriteClick/類似DOCS的代碼故事。

推到build分支，您可以使用NetLify預覽構建​​輸出。您必須登錄NetLify才能查看預覽部署。

推動main分支將輸出構建到https://www.docslikecode.com使用NetLify。自動出版作為Netlify中的設置，因此從main部署將自動發布。

主題Colophon

主題由https://mmistakes.github.io/so-simple-theme/提供

在本地建造（MacOS）

通過運行本地構建來測試您的添加和內容更改。

在MacOS上，您需要安裝Brew，Bundler.io和Ruby版本管理器，以便您可以使用Ruby的特定版本：

1. 使用Brew安裝Ruby版本管理器。

    $ 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 GEM，該寶石有助於紅寶石依賴性。

6. 運行bundle install您第一次進入docslikecode目錄。

要在本地構建：一旦您完成了準備環境，就可以在本地構建並在瀏覽器中查看網站。

1. 運行服務命令。

    $ bundle exec jekyll serve
   

2. 在瀏覽器中使用服務器地址URL http://127.0.0.1:4000/預覽內容。

3. 在服務終端中按Ctrl+C停止服務器。

提示
將服務終端打開並運行。每次將更改保存到文件時，它都會自動再生該站點，因此您可以立即測試輸出。更改需要重新啟動的唯一文件是_config.yml文件。