docslikecode

เอกสารเช่นรหัส

เว็บไซต์

เว็บไซต์นี้มีวัตถุประสงค์เพื่อเสนอเรื่องราวและบทความเกี่ยวกับวิธีการรักษาเอกสารเช่นรหัสและบทเรียนที่ได้เรียนรู้ไปพร้อมกัน คุณสามารถบอกเล่าเรื่องราวของคุณได้ที่นี่เช่นกัน

เพื่อบริจาค

คุณสามารถส่งคำขอดึงโดยตรงโดยใช้เวิร์กโฟลว์ส้อมและดึงเพื่อเพิ่มบทความหรือส่งไปยัง repo justwriteclick/docs-like-code-stories repo หากคุณต้องการติดตามเทมเพลตคำถามและคำตอบ

การผลักไปยัง build Branch ช่วยให้คุณดูตัวอย่างการสร้างโดยใช้ NetLify คุณต้องเข้าสู่ระบบ NetLify เพื่อดูการปรับใช้ตัวอย่าง

การผลักดันไปยังสาขา main สร้างผลลัพธ์ที่ https://www.docslikecode.com โดยใช้ NetLify การเผยแพร่อัตโนมัติอยู่ในการตั้งค่าใน netlify ดังนั้นการปรับใช้จาก main จะถูกเผยแพร่โดยอัตโนมัติ

ธีม colophon

ธีมได้รับความอนุเคราะห์จาก https://mmistakes.github.io/so-simple-theme/

เพื่อสร้างในพื้นที่ (macOS)

ทดสอบการเพิ่มเติมและการเปลี่ยนแปลงเนื้อหาโดยใช้งานบิลด์ท้องถิ่น

บน MacOS คุณต้องติดตั้ง Bundler.io และ Ruby Version Manager เพื่อให้คุณสามารถใช้ Ruby เวอร์ชันเฉพาะ:

1. ใช้ Brew เพื่อติดตั้งตัวจัดการเวอร์ชันทับทิม

    $ brew install rbenv ruby-build
   

2. เพิ่ม rbenv เพื่อทุบตีเพื่อให้โหลดทุกครั้งที่คุณเปิดเทอร์มินัล หากคุณใช้ 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. ติดตั้งเวอร์ชันทับทิมที่ต้องการ:

    $ 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. Run bundle install ในครั้งแรกที่คุณอยู่ในไดเรกทอรี docslikecode

ในการสร้างในพื้นที่: เมื่อคุณเตรียมสภาพแวดล้อมเสร็จแล้วคุณสามารถสร้างในพื้นที่และตรวจสอบเว็บไซต์ในเบราว์เซอร์ของคุณ

1. เรียกใช้คำสั่งเสิร์ฟ

    $ bundle exec jekyll serve
   

2. ใช้ URL ที่อยู่เซิร์ฟเวอร์ http://127.0.0.1:4000/ ในเบราว์เซอร์เพื่อดูตัวอย่างเนื้อหา

3. กด Ctrl+C ในเทอร์มินัลเสิร์ฟเพื่อหยุดเซิร์ฟเวอร์

เคล็ดลับ
ปล่อยให้เทอร์มินัลเสิร์ฟเปิดและทำงาน ทุกครั้งที่คุณบันทึกการเปลี่ยนแปลงของไฟล์จะสร้างเว็บไซต์ใหม่โดยอัตโนมัติเพื่อให้คุณสามารถทดสอบผลลัพธ์ได้ทันที ไฟล์เดียวที่การเปลี่ยนแปลงต้องการการรีสตาร์ทคือไฟล์ _config.yml