Title: Github README
Author: Jason Stallings
Published: <strong>2015 年 1 月 1 日</strong>
Last modified: 2016 年 6 月 7 日

---

搜索插件

**该插件尚未通过WordPress的最新3个主要版本进行测试**。 当与较新版本的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://cn.wordpress.org/plugins/github-readme/#description)
 * [评价](https://cn.wordpress.org/plugins/github-readme/#reviews)
 * [开发进展](https://cn.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 年 1 月 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!

## 额外信息

 *  版本 **0.2.0**
 *  最后更新：**10 年前**
 *  活跃安装数量 **10+**
 *  WordPress 版本 ** 3.0.1 或更高版本 **
 *  已测试的最高版本为 **4.5.33**
 *  语言
 * [English (US)](https://wordpress.org/plugins/github-readme/)
 * 标签
 * [embed](https://cn.wordpress.org/plugins/tags/embed/)[Github](https://cn.wordpress.org/plugins/tags/github/)
   [markdown](https://cn.wordpress.org/plugins/tags/markdown/)[readme](https://cn.wordpress.org/plugins/tags/readme/)
   [shortcode](https://cn.wordpress.org/plugins/tags/shortcode/)
 *  [高级视图](https://cn.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)