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.

1. Markdown Readme Template
2. Readme Markdown Example
3. Readme Markdown
4. Readme Markdown Link

:smiley: It is a simple markdown for readme.md files at instant. This extension is specially for Github users to easily write their most important part - 'The Documentation', very easily, without searching for markdown at other pages. Editor.md: a simple online markdown editor. 开源在线 Markdown 编辑器.

Creating a README file¶

README files for Python projects are often named README, README.txt, README.rst, or README.md.

For your README to display properly on PyPI, choose a markup language supported by PyPI.Formats supported by PyPI’s README renderer are:

• plain text

• 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 setup.py file.

Including your README in your package’s metadata¶

To include your README’s contents as your package description,set your project’s Description and Description-Content-Type metadata,typically in your project’s setup.py file.

For example, to set these values in a package’s setup.py file,use setup()’s long_description and long_description_content_type.

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/plain, text/x-rst (for reStructuredText), or text/markdown.

Note

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:

• setuptools>=38.6.0

• wheel>=0.31.0

• twine>=1.11.0

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 README.md as 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 “Error:Unknowninterpretedtextrole'py:func'.”.

You can check your README for markup errors before uploading as follows:

1. Install the latest version of twine;version 1.12.0 or higher is required:

   Unix/macOSWindows

2. Build the sdist and wheel for your project as described underPackaging your project.

3. Run twinecheck on the sdist and wheel:

   This command will report any problems rendering your README. If your markuprenders fine, the command will output CheckingdistributionFILENAME:Passed.

Markdown is a lightweight markup language for adding formatting elements to plain text. IntelliJ IDEA recognizes Markdown files, provides a dedicated editor with highlighting, completion, and formatting, and shows the rendered HTML in a live preview pane.

Create a new Markdown file

By default, IntelliJ IDEA recognizes any file with the .md or .markdown extension as a Markdown file.

1. Right-click a directory in the Project tool window Alt+1 and select New | File.

   Alternatively, you can select the necessary directory, press Alt+Insert, and then select File.

2. Enter a name for your file with a recognized extension, for example: readme.md.

The Markdown editor provides several basic formatting actions in the toolbar:

• : Bold

• : Strikethrough

• : Italic

• : Code

• : Decrease heading level

• : Increase heading level

• : Convert an inline link to a reference link

You can use the preview pane to see the rendered HTML.

There is also completion for links to files in the current project, for example, if you need to reference source code, images, or other Markdown files.

Code blocks

To insert a fenced code block, use triple backticks (```) before and after the code block. If you specify the language for the code block, by default, the Markdown editor injects the corresponding language. This enables syntax highlighting and other coding assistance features for the specified language: code completion, inspections, and intention actions.

Disable coding assistance in code blocks

If your code blocks are not meant to be syntactically correct, you may want to disable code injection and syntax errors in code blocks.

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

2. Configure the following options:

   Disable automatic language injection in code fences	Do not inject any coding assistance for code blocks.
   Hide errors in code fences	Do not check the syntax for errors.

3. Click OK to apply the changes.

Diagrams

The Markdown editor can render diagrams defined with Mermaid and PlantUML. This is disabled by default and requires the corresponding Markdown extensions.

Enable diagram support

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

2. Enable either Mermaid or PlantUML under Markdown Extensions.

3. After IntelliJ IDEA downloads the relevant extensions, click OK to apply the changes.

HTML preview

By default, the Markdown editor shows a preview pane next to it for rendered HTML code based on the Markdown file. You can use or in the top right corner of the Markdown editor to show only the editor or the preview pane.

The scrollbars in the editor and in the preview pane are synchronized, meaning that the location in the preview pane corresponds to the location in the source. To disable this, click in the top right corner of the Markdown editor.

To split the editor and preview pane horizontally (top and bottom) instead of the default vertical split, in the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown, and then select Split horizontally under Editor and Preview Panel Layout.

Custom CSS

IntelliJ IDEA provides default style sheets for rendering HTML in the preview pane. These style sheets were designed to be consistent with the default UI themes. You can configure specific CSS rules to make small presentation changes (for example, change the font size for headings or line spacing in lists) or you can provide an entirely new CSS to better match your expected output (for example, if you want to replicate the GitHub Markdown style).

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

2. Configure the settings under Custom CSS:

   • Select Load from URI to specify the location of a custom CSS file.

   • Select Add CSS rules rules to enter specific CSS rules that you want to override.

Reformat Markdown files

IntelliJ IDEA can format Markdown files with proper line wrappings, blank lines, and indentation. For more information, see Reformat and rearrange code.

• From the main menu, select Code | Reformat Code or press Ctrl+Alt+L.

IntelliJ IDEA formats the contents according to the code style settings for Markdown files.

Configure Markdown code style settings

• In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Code Style | Markdown.

Markdown code style settings include the following:

Configure the options for breaking lines.

Configure the options for nesting text blocks and alignment within a block.

Set the maximum and minimum number of blank lines to keep for various text elements.

Specify which elements should have exactly one space.

Productivity tips

Markdown Readme Template

Customize highlighting for Markdown

Readme Markdown Example

IntelliJ IDEA highlights various Markdown elements according to the color scheme settings.

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Color Scheme | Markdown.

2. Select the color scheme, accept the highlighting settings inherited from defaults, or customize them as described in Configuring colors and fonts.

Navigate in a large Markdown file

Readme Markdown

• Use the Structure tool window Alt+7 or the File Structure popup Ctrl+F12 to view and jump to the relevant headings.

Markdown does not have dedicated syntax for commenting out lines. However, it is possible to emulate a comment line using a link label without an address, like this:

There must be a blank line before the link label.

Readme Markdown Link

• Put the caret at the line that you want to comment out and press Ctrl+/.

  This will add a link label with the commented out text in parentheses and a blank line before it if necessary. Press the same shortcut to uncomment.