Title: Github README
Author: Jason Stallings
Published: <strong>1 janvier 2015</strong>
Last modified: 7 juin 2016

---

Recherche d’extensions

Cette extension **n’a pas été testée avec plus de trois mises à jour majeures de
WordPress**. Elle peut ne plus être maintenue ou supportée et peut avoir des problèmes
de compatibilité lorsqu’elle est utilisée avec des versions de WordPress plus récentes.

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

# Github README

 Par [Jason Stallings](https://profiles.wordpress.org/octalmage/)

[Télécharger](https://downloads.wordpress.org/plugin/github-readme.zip)

 * [Détails](https://fr.wordpress.org/plugins/github-readme/#description)
 * [Avis](https://fr.wordpress.org/plugins/github-readme/#reviews)
 * [Développement](https://fr.wordpress.org/plugins/github-readme/#developers)

 [Support](https://wordpress.org/support/plugin/github-readme/)

## Description

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.

## Avis

![](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 janvier 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.

 [ Lire les 4 avis ](https://wordpress.org/support/plugin/github-readme/reviews/)

## Contributeurs/contributrices & développeurs/développeuses

« Github README » est un logiciel libre. Les personnes suivantes ont contribué à
cette extension.

Contributeurs

 *   [ 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/)

[Traduisez « Github README » dans votre langue.](https://translate.wordpress.org/projects/wp-plugins/github-readme)

### Le développement vous intéresse ?

[Parcourir le code](https://plugins.trac.wordpress.org/browser/github-readme/), 
consulter le [SVN dépôt](https://plugins.svn.wordpress.org/github-readme/), ou s’inscrire
au [journal de développement](https://plugins.trac.wordpress.org/log/github-readme/)
par [RSS](https://plugins.trac.wordpress.org/log/github-readme/?limit=100&mode=stop_on_copy&format=rss).

## Journal des modifications

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

## Méta

 *  Version **0.2.0**
 *  Dernière mise à jour **il y a 10 ans**
 *  Installations actives **20+**
 *  Version de WordPress ** 3.0.1 ou plus **
 *  Testé jusqu’à **4.5.33**
 *  Langue
 * [English (US)](https://wordpress.org/plugins/github-readme/)
 * Étiquettes
 * [embed](https://fr.wordpress.org/plugins/tags/embed/)[Github](https://fr.wordpress.org/plugins/tags/github/)
   [markdown](https://fr.wordpress.org/plugins/tags/markdown/)[readme](https://fr.wordpress.org/plugins/tags/readme/)
   [shortcode](https://fr.wordpress.org/plugins/tags/shortcode/)
 *  [Vue avancée](https://fr.wordpress.org/plugins/github-readme/advanced/)

## Évaluations

 5 sur 5 étoiles.

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

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

[Voir tous les avis](https://wordpress.org/support/plugin/github-readme/reviews/)

## Contributeurs

 *   [ 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/)

## Support

Quelque chose à dire ? Besoin d’aide ?

 [Voir le forum de support](https://wordpress.org/support/plugin/github-readme/)

## Faire un don

Souhaitez-vous soutenir l’avancement de cette extension ?

 [ Faire un don à cette extension ](http://jason.stallin.gs)