You just start writing Markdown text, save the file with the.md extension and then you can toggle the visualization of the editor between the code and the preview of the Markdown file; obviously, you can also open an existing Markdown file and start working with it. To switch between views, press Ctrl+Shift+V in the editor. Links look like this in the Markdown editor: And result in a link that looks like this: ReadMe. Reference-Style Linking Reference-style linking allows you to give a link a number or 'name' and refer to it multiple times. For example, if I type in: It looks like this: When I first search something I look at Google then at Yahoo then MSN.
README files can help your users understand your project and can be used to set your project’s description on PyPI.This guide helps you create a README in a PyPI-friendly format and include your README in your package so it appears on PyPI.
Creating a README file¶
README files for Python projects are often named
For your README to display properly on PyPI, choose a markup language supported by PyPI.Formats supported by PyPI’s README renderer are:
reStructuredText (without Sphinx extensions)
Markdown (GitHub Flavored Markdown by default,or CommonMark)
It’s customary to save your README file in the root of your project, in the same directory as your
Including your README in your package’s metadata¶
To include your README’s contents as your package description,set your project’s
Description-Content-Type metadata,typically in your project’s
For example, to set these values in a package’s
Set the value of
long_description to the contents (not the path) of the README file itself.Set the
long_description_content_type to an accepted
Content-Type-style value for your README file’s markup,such as
text/x-rst (for reStructuredText), or
If you’re using GitHub-flavored Markdown to write a project’s description, ensure you upgradethe following tools:
The minimum required versions of the respective tools are:
It’s recommended that you use
twine to upload the project’s distribution packages:
For example, see this
setup.py file,which reads the contents of
long_descriptionand identifies the markup as GitHub-flavored Markdown:
Validating reStructuredText markup¶
If your README is written in reStructuredText, any invalid markup will preventit from rendering, causing PyPI to instead just show the README’s raw source.
Note that Sphinx extensions used in docstrings, such asdirectives and roles(e.g., “
:py:func:`getattr`” or “
:ref:`my-reference-label`”), are not allowed here and will result in errormessages like “
You can check your README for markup errors before uploading as follows:
Install the latest version of twine;version 1.12.0 or higher is required:
Build the sdist and wheel for your project as described underPackaging your project.
twinecheckon the sdist and wheel:
This command will report any problems rendering your README. If your markuprenders fine, the command will output
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
What you will learn:
- How the Markdown format makes styled collaborative editing easy
- How Markdown differs from traditional formatting approaches
- How to use Markdown to format text
- How to leverage GitHub’s automatic Markdown rendering
- How to apply GitHub’s unique Markdown extensions
What is Markdown?
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like
You can use Markdown most places around GitHub:
- Comments in Issues and Pull Requests
- Files with the
For more information, see “Writing on GitHub” in the GitHub Help.
Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.
Readme Markdown Table
GitHub Flavored Markdown
GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.
Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.
Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
You can also simply indent your code by four spaces:
Here’s an example of Python code without syntax highlighting:
If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!
You can create tables by assembling a list of words and dividing them with hyphens
- (for the first row), and then separating each column with a pipe
|First Header||Second Header|
|Content from cell 1||Content from cell 2|
|Content in the first column||Content in the second column|
Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.
Issue references within a repository
Any number that refers to an Issue or Pull Request will be automatically converted into a link.
Readme Markdown Guide
@ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.
Automatic linking for URLs
Readme Markdown Image
Any URL (like
http://www.github.com/) will be automatically converted into a clickable link.
Any word wrapped with two tildes (like
~~this~~) will appear crossed out.
GitHub supports emoji!
To see a list of every image we support, check out the Emoji Cheat Sheet.
Last updated Jan 15, 2014