Title: Github README
Author: Jason Stallings
Published: <strong>جنوری 1, 2015</strong>
Last modified: جون 7, 2016

---

جستجوی افزونه‌ها

این افزونه **با آخرین 3 نسخه اصلی وردپرس تست نشده است**. ممکن است دیگر نگهداری یا
پشتیبانی نشود و ممکن است هنگام استفاده با نسخه های جدیدتر وردپرس مشکلات سازگاری 
داشته باشد.

![](https://s.w.org/plugins/geopattern-icon/github-readme.svg)

# Github README

 توسط [Jason Stallings](https://profiles.wordpress.org/octalmage/)

[دانلود](https://downloads.wordpress.org/plugin/github-readme.zip)

 * [جزئیات](https://fa-af.wordpress.org/plugins/github-readme/#description)
 * [نقد و بررسی‌ها](https://fa-af.wordpress.org/plugins/github-readme/#reviews)
 * [توسعه](https://fa-af.wordpress.org/plugins/github-readme/#developers)

 [پشتیبانی](https://wordpress.org/support/plugin/github-readme/)

## توضیحات

Github README is a plugin that allows you to embed markdown from GitHub in a page
or post using a simple shortcode.

Usage:

**github_readme**

This shortcode embeds the project’s readme.

[github_readme repo=”octalmage/Marknote”]

You can also trim lines from the top of the readme using the “trim” option:

[github_readme repo=”octalmage/Marknote” trim=”3″]

This is useful for removing titles since your page/post will most likely already
have one.

**github_markdown**

This shortcode embeds any markdown file found in the repository.

[github_markdown repo=”octalmage/Marknote” file=”README.md”]

trim, branch, and cache (seconds to cache) also supported.

**github_wikipage**

This shortcode embeds pages from a project’s wiki.

[github_wikipage repo=”octalmage/Marknote” page=”Syntax”]

trim and cache also supported.

## نقد و بررسی‌ها

![](https://secure.gravatar.com/avatar/0be55fa25959854681627b0d9595d1b4e0fe00bf4fd4dcb29f2ca71c3dc2fb07?
s=60&d=retro&r=g)

### 󠀁[Very Good!](https://wordpress.org/support/topic/very-good-1797/)󠁿

 [Odyno](https://profiles.wordpress.org/odyno/) جنوری 2, 2017

As described… it work fine and very well! One suggestion: from the guide https://
guides.github.com/features/mastering-markdown/ the relative images are resolved 
with absolute path on the github repository.

 [ خواندن تمامی 4 نقد و بررسی‌ ](https://wordpress.org/support/plugin/github-readme/reviews/)

## توسعه دهندگان و همکاران

“Github README” نرم افزار متن باز است. افراد زیر در این افزونه مشارکت کرده‌اند.

مشارکت کنندگان

 *   [ Jason Stallings ](https://profiles.wordpress.org/octalmage/)
 *   [ olensmar ](https://profiles.wordpress.org/olensmar/)
 *   [ ianmjones ](https://profiles.wordpress.org/ianmjones/)
 *   [ nlenkowski ](https://profiles.wordpress.org/nlenkowski/)

[ترجمه “Github README” به زبان شما.](https://translate.wordpress.org/projects/wp-plugins/github-readme)

### علاقه‌ مند به توسعه هستید؟

[کد را مرور کنید](https://plugins.trac.wordpress.org/browser/github-readme/), را
بررسی کنید [مخزن SVN](https://plugins.svn.wordpress.org/github-readme/), یا مشترک
شوید [گزارش توسعه](https://plugins.trac.wordpress.org/log/github-readme/) توسط [RSS](https://plugins.trac.wordpress.org/log/github-readme/?limit=100&mode=stop_on_copy&format=rss).

## گزارش تغییرات

#### 0.2.0

 * Improved markdown rendering with MarkdownExtra.

Special thanks to nlenkowski!

#### 0.1.1

 * Add “cache” attribute to the github_readme shortcode.
 * Add “branch” attribute to the github_readme shortcode.
 * Add the ability to use the `shortcode_atts_{$shortcode}` filter.
 * Fix transients so they are properly referenced when attributes are changed.

Special thanks to ianmjones!

#### 0.1.0

 * Added new github_markdown and github_wikipage shortcodes (thanks olensmar!).

#### 0.0.3

 * Fixed plugin name.

#### 0.0.2

 * Fixed plugin header.

#### 0.0.1

 * First Version. Stable so far!

## اطلاعات

 *  Version **0.2.0**
 *  Last updated **10 سال پیش**
 *  Active installations **20+**
 *  WordPress version ** 3.0.1 یا بالاتر **
 *  Tested up to **4.5.33**
 *  Language
 * [English (US)](https://wordpress.org/plugins/github-readme/)
 * Tags
 * [embed](https://fa-af.wordpress.org/plugins/tags/embed/)[Github](https://fa-af.wordpress.org/plugins/tags/github/)
   [markdown](https://fa-af.wordpress.org/plugins/tags/markdown/)[readme](https://fa-af.wordpress.org/plugins/tags/readme/)
   [shortcode](https://fa-af.wordpress.org/plugins/tags/shortcode/)
 *  [نمایش پیشرفته](https://fa-af.wordpress.org/plugins/github-readme/advanced/)

## امتیازها

 5 out of 5 stars.

 *  [  4 5-star reviews     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=5)
 *  [  0 4-star reviews     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=4)
 *  [  0 3-star reviews     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=3)
 *  [  0 2-star reviews     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=2)
 *  [  0 1-star reviews     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=1)

[Your review](https://wordpress.org/support/plugin/github-readme/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/github-readme/reviews/)

## مشارکت کنندگان

 *   [ Jason Stallings ](https://profiles.wordpress.org/octalmage/)
 *   [ olensmar ](https://profiles.wordpress.org/olensmar/)
 *   [ ianmjones ](https://profiles.wordpress.org/ianmjones/)
 *   [ nlenkowski ](https://profiles.wordpress.org/nlenkowski/)

## پشتیبانی

چیزی برای گفتن دارید؟ نیاز به کمک دارید؟

 [مشاهده انجمن پشتیبانی](https://wordpress.org/support/plugin/github-readme/)

## کمک مالی

آیا تمایل دارید از پیشرفت این افزونه حمایت کنید؟

 [ کمک مالی به این افزونه ](http://jason.stallin.gs)