Preview a README

Inspect README headings, code, tables and local images before saving a new copy.

  1. Start or open

    Open the README from your device. For a project, open its folder or ZIP with the Markdown documents and images.

  2. Preview the document

    Choose GitHub Flavored Markdown and inspect the headings, code and tables. Relative links can open documents already in the session.

  3. Check and download

    Review link and image problems, then save Markdown or a ZIP project. Your original project is not changed by a normal download.

Guides for your next step

Choose a task, check its limits and follow the steps.

Keep the source. Choose your copy.

Download Markdown, HTML, Word, plain text, OpenDocument, EPUB or ZIP. Print to PDF with your browser.

Open workspace