Title: Github README
Author: Jason Stallings
Published: <strong>2015-يىلى 1-يانۋار</strong>
Last modified: 2016-يىلى 7-ئىيۇن

---

قىستۇرما ئىزدە

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](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://ug.wordpress.org/plugins/github-readme/#description)
 * [باھالاشلار](https://ug.wordpress.org/plugins/github-readme/#reviews)
 * [ئىجادىيەت](https://ug.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/) 2017-يىلى 2-يانۋار

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/) تەكشۈرۈپ ياكى [RSS](https://plugins.trac.wordpress.org/log/github-readme/?limit=100&mode=stop_on_copy&format=rss)
ئارقىلىق [ئىجادىيەت خاتىرىسى](https://plugins.trac.wordpress.org/log/github-readme/)
گە مۇشتەرى بولغىلى بولىدۇ.

## ئۆزگىرىش خاتىرىسى

#### 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!

## Meta

 *  Version **0.2.0**
 *  ئاخىرقى يېڭىلانغان ۋاقىت **10 يىل بۇرۇن**
 *  ئاكتىپ ئورنىتىش سانى **20+**
 *  WordPress نەشرى ** 3.0.1 ياكى يۇقىرى **
 *  **4.5.33** دا سىنالغان
 *  تىل
 * [English (US)](https://wordpress.org/plugins/github-readme/)
 * بەلگە
 * [embed](https://ug.wordpress.org/plugins/tags/embed/)[Github](https://ug.wordpress.org/plugins/tags/github/)
   [markdown](https://ug.wordpress.org/plugins/tags/markdown/)[readme](https://ug.wordpress.org/plugins/tags/readme/)
   [shortcode](https://ug.wordpress.org/plugins/tags/shortcode/)
 *  [ئالىي كۆرۈنۈش](https://ug.wordpress.org/plugins/github-readme/advanced/)

## دەرىجە

 5/5 يۇلتۇز

 *  [  4 5-يۇلتۇز باھالاش     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=5)
 *  [  0 4-يۇلتۇز باھالاش     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=4)
 *  [  0 3-يۇلتۇز باھالاش     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=3)
 *  [  0 2-يۇلتۇز باھالاش     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=2)
 *  [  0 1-يۇلتۇز باھالاش     ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=1)

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

[بارلىق ئىنكاسنى كۆرسەت](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)