docslikecode

مستندات مثل الكود

الموقع

يهدف هذا الموقع إلى تقديم قصص ومقالات حول كيفية علاج المستندات مثل الكود ، والدروس المستفادة على طول الطريق. اهلا وسهلا بك لرواية قصتك هنا أيضًا.

للمساهمة

يمكنك إرسال طلب سحب مباشرة باستخدام سير العمل الشوكة والملاحظة لإضافة مقال ، أو الإرسال إلى Repo JustwriteClick/Docs-Code-Staries إذا كنت ترغب في اتباع قالب أسئلة وأجوبة.

يتيح لك الدفع إلى فرع build معاينة إخراج البناء باستخدام NetLify. يجب تسجيل الدخول إلى NetLify لعرض نشر المعاينة.

إن الضغط على الفرع main يبني الإخراج إلى https://www.docslikecode.com باستخدام NetLify. يتم نشر Auto Publishing كإعداد في NetLify ، لذلك يتم نشرها من main تلقائيًا.

موضوع كولوفون

موضوع من باب المجاملة https://mmistakes.github.io/so-simple-me-mon

لبناء محليًا (MacOS)

اختبر الإضافات والتغييرات في المحتوى عن طريق تشغيل بناء محلي.

على MacOS ، تحتاج إلى تثبيت Brew و Bundler.io و Ruby Personal Manager حتى تتمكن من استخدام إصدار معين من 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 لتثبيت GEM Bundler ، والتي تساعد في تبعيات Ruby.

6. قم bundle install أول مرة أنت فيها في دليل docslikecode .

للبناء محليًا: بمجرد الانتهاء من إعداد بيئتك ، يمكنك بناء الموقع محليًا ومراجعة الموقع في متصفحك.

1. قم بتشغيل أمر الخدمة.

    $ bundle exec jekyll serve
   

2. استخدم عنوان URL عنوان الخادم http://127.0.0.1:4000/ في متصفح لمعاينة المحتوى.

3. اضغط على Ctrl+C في محطة الخدمة لإيقاف الخادم.

نصيحة
اترك محطة الخدمة مفتوحة وتشغيل. في كل مرة تقوم فيها بحفظ التغييرات إلى ملف ، تقوم تلقائيًا بتجديد الموقع حتى تتمكن من اختبار الإخراج على الفور. الملف الوحيد الذي تتطلب فيه التغييرات إعادة التشغيل هو ملف _config.yml .