| CARVIEW |
Select Language
HTTP/2 302
server: nginx
date: Fri, 08 Aug 2025 18:15:59 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20091201122906
location: https://web.archive.org/web/20091201122906/https://github.com/guides/readme-formatting
server-timing: captures_list;dur=1.191848, exclusion.robots;dur=0.040439, exclusion.robots.policy;dur=0.018486, esindex;dur=0.018395, cdx.remote;dur=90.834551, LoadShardBlock;dur=415.927692, PetaboxLoader3.datanode;dur=162.173595, PetaboxLoader3.resolve;dur=150.102524
x-app-server: wwwb-app204
x-ts: 302
x-tr: 568
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=1
set-cookie: wb-p-SERVER=wwwb-app204; path=/
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
HTTP/2 200
server: nginx
date: Fri, 08 Aug 2025 18:16:00 GMT
content-type: text/html; charset=utf-8
x-archive-orig-server: nginx/0.7.61
x-archive-orig-date: Tue, 01 Dec 2009 12:29:06 GMT
x-archive-orig-connection: close
x-archive-orig-status: 200 OK
x-archive-orig-etag: "a5234f6573236615b7c34ba2b2a3de94"
x-archive-orig-x-runtime: 111ms
x-archive-orig-content-length: 11049
x-archive-orig-cache-control: private, max-age=0, must-revalidate
x-archive-guessed-content-type: text/html
x-archive-guessed-charset: utf-8
memento-datetime: Tue, 01 Dec 2009 12:29:06 GMT
link: ; rel="original", ; rel="timemap"; type="application/link-format", ; rel="timegate", ; rel="first memento"; datetime="Thu, 31 Jul 2008 12:23:34 GMT", ; rel="prev memento"; datetime="Mon, 21 Sep 2009 17:28:00 GMT", ; rel="memento"; datetime="Tue, 01 Dec 2009 12:29:06 GMT", ; rel="next memento"; datetime="Wed, 06 Jan 2010 14:06:26 GMT", ; rel="last memento"; datetime="Mon, 07 Mar 2022 00:29:16 GMT"
content-security-policy: default-src 'self' 'unsafe-eval' 'unsafe-inline' data: blob: archive.org web.archive.org web-static.archive.org wayback-api.archive.org athena.archive.org analytics.archive.org pragma.archivelab.org wwwb-events.archive.org
x-archive-src: 51_13_20091201091714_crawl103-c/51_13_20091201122803_crawl101.arc.gz
server-timing: captures_list;dur=0.622436, exclusion.robots;dur=0.024401, exclusion.robots.policy;dur=0.010769, esindex;dur=0.011276, cdx.remote;dur=9.378477, LoadShardBlock;dur=115.952208, PetaboxLoader3.datanode;dur=80.494153, load_resource;dur=193.429596, PetaboxLoader3.resolve;dur=148.852765
x-app-server: wwwb-app204
x-ts: 200
x-tr: 378
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=1
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
content-encoding: gzip
README Formatting - Guides - GitHub
Guides: README Formatting
Guides: README Formatting
You can make your README formatted by putting README with specific extension.
Supported Formats
| format | extension |
|---|---|
| rdoc | README.rdoc |
| Markdown | README.markdown, README.md, README.mdown, README.mkd, README.mkdn |
| Textile | README.textile |
| PNG | README.png (will display the image) |
| reStructuredText | README.rst |
| (no formatting) | README.* (all but above extensions), README (no extension) |
Unsupported Formats
- rd (README.rd)
- html (README.html — considered insecure)
Notes
- If there is both README and README.foo, README.foo is displayed.
- feature request: format READMEs without an extension
- feature request: POD
- feature request: AsciiDoc
- feature request: TiddlyWiki Syntax
- feature request: Something MediaWiki like such as MediaCloth or WikiCreole
- feature request: txt2tags
- reStructuredText: there are certain, specific kinds of content that will cause the .rst renderer to fail. In particular, certain non-latin unicode glyphs will cause README.rst’s to not render on github while rendering perfectly happily using rst2html.py. If your README.rst will not render, try looking for unusual content in your .rst and stripping it out, and seeing if that has an effect.
Last edited by jdale, about 11 hours ago
Versions:
This feature is coming soon. Sit tight!