| CARVIEW |
Select Language
HTTP/2 302
server: nginx
date: Mon, 28 Jul 2025 07:12:46 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20090721032821
location: https://web.archive.org/web/20090721032821/https://github.com/guides/readme-formatting
server-timing: captures_list;dur=0.502532, exclusion.robots;dur=0.019280, exclusion.robots.policy;dur=0.009017, esindex;dur=0.011133, cdx.remote;dur=85.240817, LoadShardBlock;dur=254.994079, PetaboxLoader3.datanode;dur=74.015418, PetaboxLoader3.resolve;dur=129.127221
x-app-server: wwwb-app225
x-ts: 302
x-tr: 368
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
set-cookie: SERVER=wwwb-app225; 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: Mon, 28 Jul 2025 07:12:47 GMT
content-type: text/html; charset=utf-8
x-archive-orig-server: nginx/0.6.26
x-archive-orig-date: Tue, 21 Jul 2009 03:28:21 GMT
x-archive-orig-connection: close
x-archive-orig-status: 200 OK
x-archive-orig-x-runtime: 479ms
x-archive-orig-etag: "a22b123d58e2058aa45122046c890919"
x-archive-orig-cache-control: private, max-age=0, must-revalidate
x-archive-orig-content-length: 8857
x-archive-guessed-content-type: text/html
x-archive-guessed-charset: utf-8
memento-datetime: Tue, 21 Jul 2009 03:28:21 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="Sat, 18 Apr 2009 18:46:48 GMT", ; rel="memento"; datetime="Tue, 21 Jul 2009 03:28:21 GMT", ; rel="next memento"; datetime="Fri, 21 Aug 2009 08:35:50 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_10_20090721022043_crawl103.gpg-c/51_10_20090721032310_crawl101.arc.gz
server-timing: captures_list;dur=0.452830, exclusion.robots;dur=0.017263, exclusion.robots.policy;dur=0.008862, esindex;dur=0.010341, cdx.remote;dur=123.954363, LoadShardBlock;dur=188.689860, PetaboxLoader3.resolve;dur=199.121604, PetaboxLoader3.datanode;dur=82.228785, load_resource;dur=127.728356
x-app-server: wwwb-app225
x-ts: 200
x-tr: 496
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)
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
- 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 ssokolow, 24 days ago
Versions:
This feature is coming soon. Sit tight!