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文件。