آموزش GitHub Wiki

علی حسین شهابی

1395/8/24

نظر0

سلام و احترام خدمت شما دوستان

امروز درباره ویکی های گیت هاب (GitHub Wikis) صحبت می کنیم .

در سایت گیت هاب (github)  برای هر repository یک بخش به نام Wiki وجود دارد. در این بخش می توانیم توضیحات کامل پروژه ی خودمون را در قالب یک داکیومنت بنویسیم. Wiki می تواند دارای تعداد صفحات دلخواه باشد . همچنین می توانی برای آن سایدبار یا فوتر نیز قرار دهیم . خب این داکیومنت خیلی به گسترش پروژه ما توسط دیگران کمک می کند .

صفحه ی Wiki

صفحه ی Wiki

پس Wiki محل مناسبی میتونه باشه برای بیان طرز استفاده ی کامل از پروژه ی ما , نحوه طراحی پروژمون , قانون هایی که پروژمون داره و غیره ….

فرق Wiki با README این هست که README برای توضیحات خلاصه تری نسبت به Wiki می باشد و عملا باید شامل توضیحاتی باشد که کاربر در نگاه اول به آن نیاز دارد .

داخل صفحات Wiki می توانیم فرمت های مختلفی رو استفاده کنیم . که رایج ترین آنها استفاده از Markdown است و گیت هاب خودش عملیات تبدیل کدهای Markdown به Html را برای ما موقع نمایش صفحه انجام می دهد . فرمت های دیگری که می توانیم استفاده کنیم شامل  RST, Textile و … می باشد.

برای ادیت صفحات Wiki  می توانیم مستقیما از طریق خود گیت هاب (github)  وارد عمل بشیم و یا اینکه روی سیستم خودمون تغییرات را انجام بدیم و در نهایت آنها را push نماییم.

به صورت default کسانی که به پروژمون add شده باشن می توانن محتوای ویکی ( Wiki ) ها را تغییر دهند ولی میتوانیم در settings در قسمت Features با برداشتن تیک Restrict editing to collaborators only اعلام کنیم هر کسی می تواند محتوای ویکی را عوض کند .

 

Adding wiki pages via the online interface

برای اضافه کردن اولین صفحه به Wiki :

  • ابتدا پروژه ی خودتون در گیت هاب (github) رو انتخاب کنید و داخل repository پروژتون بشین .
  • سپس روی Wiki داخل repository کلیک کنید .
  • در منوی بالایی روی New Page کلیک کنید.
آموزش ویکی

آموزش ویکی

آموزش ویکی

آموزش ویکی

صفحات ویکی ( Wiki ) می تواند شامل تمام فرمت هایی باشد که گیت هاب پشتیبانی می کند که به صورت default بر روی Markdown می باشد اما در قسمت Edit mode می توانید زبان های نشانه گذاری دیگری را برای صفحه ی خود انتخاب نمایید .

آموزش ویکی

آموزش ویکی

برای درج محتوای صفحه می توانیم از ادیتوری که وجود دارد استفاده کنیم و محتوای مورد نظرمون را ایجاد نماییم.

آموزش ویکی

آموزش ویکی

بعد از نوشتن محتوا در باکس پایین متنی درباره ی محتوای جدیدتون به عنوان commit message بنویسید و دکمه Save را کلیک کنید .

 

Editing wiki pages via the online interface

برای ویرایش صفحات ویکی ( Wiki ) وارد repository مربوطه بشین . روی Wiki کلیک کنید و در منو روی Edit کلیک کنید .

آموزش wiki

آموزش wiki

تغییرات خودتون رو انجام بدین . در قسمت Edit Message پیغام مربوط به این تغییرات رو بنویسید و دکمه Save  را کلیک نمایید.

Creating a footer

می توانیم برای Wiki یک قسمت Footer ایجاد کنیم و به فرض متن کپی رایت مورد نظرمون را داخل اش قرار دهیم . برای این منظور وارد Repository  پروژه بشوین و روی دکمه ی Add a custom footer کلیک نمایید.در صفحه ی باز شده می توانید محتوای بخش فوتر را ایجاد نمایید و همانند قسمت های قبلی یک متن مناسب برای Commit بنوسید و روی دکمه ی Save  کلیک نمایید.

wiki_add_footer

Creating a sidebar

ساخت Sidebar هم دقیقا همانند ساخت Footer هست که بالا اشاره کردم. ابتدا وارد Repository پروژه بشوین سپس روی Wiki کلیک کنید و بعد از آن روی Add a custom sidebar کلیک نمایید سپس مابقیه مراحل دقیقا مانند Footer می باشد.

wiki_add_sidebar

Adding and editing wiki pages locally

شما می توانید به جای اینکه تغییرات را به صورت مستقیم در سایت گیت هاب بدهید , آن را در سیستم لوکال خودتون انجام بدین و تغییرات نهایی را push کنید .

ابتدا باید یک clone از فایل های ویکی ( Wiki )  تهیه کنیم.این کار دقیقا مانند Clone گرفتم از Repository های معمولی است.

wiki_clone_url

برای Clone گرفتم از دستور زیر استفاده نمایید  :

git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# Clones the wiki locally

وقتی فایل های ویکی ( Wiki ) را Clone کردین.. تغییرات رو راحت انجام بدین فایل ها رو کم یا زیاد کنید  سپس تمام تغییرات را commit  کنید و Push نمایید.

 

Naming wiki files

  • نام صفحه ی شما دقیقا همان تایتل صفحه ی شما می شود  .
  • گیت هاب با استفاده از پسوند فایل هاتون متوجه می شود که محتوای فایل ها از چه نوع زبان نشانه گذاری ای هست و چگونه آن را به html تبدیل کند.

این دو نکته را که مربوط به نام گذاری فایل هایتان است توجه نمایید حتما.

 

Creating footers and sidebars locally

دربالاتر نحوه ی ایجاد فوتر و سایدبار را اشاره کردم که به صورت مستقیم داخل خود گیت هاب انجام میشد. راه دومی که الان میخوام بگم ایجاد فوتر و سایدبار به صورت دستی و روی سیستم لوکال خودمون است . برای اینکار باید فایل هایی با نام های Footer_ و Sidebar_ ایجاد نمایید و محتوای خودتون را داخل اش قرار دهید.

به _ و بزرگی حرف اول نام آنها توجه نمایید.

 

Viewing a wiki’s history of changes

برای دیدن تمام تغییراتی که روی WIKI اعمال کردین باید وارد Repository بشید سپس روی wiki کلیک کنید .

از سمت راست روی صفحه دلخواهتون کلیک کنید سپس در منوی بالا روی comments کلیک کنید تا کامنت ها با جزییاتشون نمایش یابد.

wiki_history_table

جدولی که تاریخچه ویکی را نمایش میدهد اطلاعات مفیدی در اختیار ما میگذارد :

  • نام کاربری شخصی که تغییر داده .
  • تاریخ دقیق تغییر
  • پیغام یا commit تغییر

 

Disabling wikis

ممکنه بعضی وقت ها لازم داشته باشین که wiki را برای برخی repository ها غیر فعال کنید..برای این کار وارد Settings بشید و در قسمت Features تیک کنار گزینه wiki را بر دارید .

وقتی شما یک wiki را غیر فعال می کنید تمام محتویات آن hidden می شود. بعدا وقتی دوباره تیک گزینه wiki را بزنید می توانید آن محتویات را نمایش دهید و هیچ کدام پاک نمی شوند.

اینستاگرام علی حسین شهابی لینکدین علی حسین شهابی

2 نظر

( 1396/2/5 )جواد

با سلام من میخوام یه کتاب در ویکی گیت هاب بصورت صفحات html بنویسم آیا میتوان هنگام نوشتن در باکس ویکی گیت هاب بصورت راست به چئ نوشت؟ اگر بله لطفا راهنمایی فرمایید. با تشکر

( 1396/2/7 )علی حسین شهابی

سلام جواد جان حقیقتش من چیز بدرد بخوری پیدا نکردم برای این قضیه .. خودمم همین مشکل رو داشتم که در نهایت بی خیال اش شدم زیاد روش وقت نزاشتم .... خوشحال میشم اگه مشکل راست به چپ ات حل شد , اینجا قرار بدی

ارسال نظر جدید

 
Not signed in

کلیه حقوق مادی و معنوی , متعلق به سایت (Alihossein.ir)می باشد ,انتشار مطالب بدون ذکر منبع از نظر اخلاقی و شرعی صحیح نمی باشد.