1. Pypi Markdown Readme
2. Install Markdown Pypi

Released:

The markdowndeux facilities typically take an optional 'style' argument. This is a name for a set of options to the python-markdown2 processor. There is a 'default' style that is used if no argument is given. See the MARKDOWNDEUXSTYLES setting below for more.

Django markdown support and wysiwyg. 0.9.5 - a JavaScript package on PyPI - Libraries.io. A more liberal autolink extension for python Markdown - r0wb0t/markdown-urlize.

A renderer for markdown text onto pygame surfaces.

Project description

Purpose

The package's class parses and renders the contents of a markdown file onto a pygame surface.

Usage

1. Instantiation

The class instantiation takes one parameter: the path to the local markdown file.

2. Set the surface, location and area

To display the content of the markdown file on a specific surface in a specific location use the method:

• surface - the pygame surface which the text is blitted on
• offset_X - the offset of the text from the surface's left sided border
• offset_Y- the offset of the text from the surface's top border

Optional:

• textAreaWidth - the width of the textarea
• textAreaHeight - the height of the textarea

If no width/height is supplied, the entire length - starting from the x-/y-coordinateto the right/bottom side of the supplied surface - is used.

3. Display

In the pygame loop, the method display renders the contents of the markdown file onto the surface.In order to allow for scrolling, the display method requires some values from pygame.

Internal workings

The class uses a two stage process to render the contents of a markdown file onto a pygame surface.For an overview of the implemented syntactic markdown structures, see Markdown element implementations.

Stage 1: Parsing

The markdown file is parsed to HTML using the package markdown.

Based on the HTML-markers for different types of paragraphs, lists and headers, the text is split into thematic blocks.

Stage 2: Rendering

Each block is rendered based on its specifications. Inline formatting such as bold/strong, italic and codeare taken into account during the rendering process.

• Text (excluding code-blocks!) is automatically continued in the next line if the supplied width is too small for theparagraph to fit into one line.
• Code is indented and has a different background color
• Quotes are indentend, have a different font color and a vertical rectangle in front of the text.
• Horizontal rule blocks are rendered as a horizontal rectangle along the width of the textarea.

Customization

The visuals of the markdown code can be customized with the following function.All functions have default values for the parameters.

Text Format

• Setting gaps after lines and paragraphs respectively:

Fonts

• Setting the font for the normal text and for the code-blocks independently.The module uses pygame.font.SysFont. Possible options are Verdana, Arial, CourierNew, Helvetica etc.The Fonts are given by name as Strings.

• Setting Font sizes for the three headers, normal text and code-blocks.

Coloring

• Setting the background color of the markdown area

• Setting the general font color of via rgb codes (no default values)

• Setting the font color of quote-blocks via rgb codes (no default values)

• Setting the background color of the code-blocks via rgb codes (no default values)

• Setting the color of the horizontal line:

Pypi Markdown Readme

Markdown element implementations

The following table gives an overview on which markdown elements are implemented so far and can be displayed correctly.

Limitations

Warning: Disregarding the following limitations leads to unpredictable outcomes.

A further indented sublist within a list (2nd level items) is not possible at the moment.

Codeblocks are not wrapped. This can lead to code being displayed to the right side of the text area if a code lineis longer than the specified width of the textarea.

Code blocks do not recognize language strings. Code highlighting is hence not implemented.

Overloading the format of a word with bold and italic at the same time is not possible.

Inline formatting is currently only recognized if a whitespace leads and trails the formatting characters.

Incorrect Example:

Correct example:

Contributing

I welcome pull requests from the community.Please take a look at the TODO file for opportunities to help this project.

Please ensure your PR fulfills the following requirements:

• English code documentation - including doc-strings for new methods.
• Pull Requests must fulfill at least one of the following purposes:
  • Bugfixing
  • New functionality (or extending the existing functionalities)
  • Enhancement concerning performance or ease of use.
• The README is updated accordingly.
• Your code should pass PEP8. You can check your code's PEP8 compliance here.The exception is the errorcode E501 - line too long - because 79 characters per line is a stupid limit.

Full example

The following code is a full example of how the package can be used.

Release historyRelease notifications | RSS feed

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.9.2

1.0.9.1

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Hashes for pygame_markdown-1.1.4-py3-none-any.whl

Hashes for pygame-markdown-1.1.4.tar.gz

Dustin Ingram

Finally! #

I’m really excited to say that as of today, PyPI supports rendering projectdescriptions from Markdown! This has been a oft-requested feature and afterlots of work (including the creation of PEP566) it is now possible, withouttranslating Markdown to rST or any other hacks!

For example, this markdown-description-exampleproject has a Markdowndescription, take a look at the sourcehere.

Here are the steps necessary to make a new release with a Markdown descriptionof your project:

1. Have a README.md#

And make sure it contains markdown. The extension doesn’t have to be .md(.mkdn or .markdown or anything else is fine), just be sure you’re readingit in and setting it as the long_description.

2. Add a new argument in setup.py: #

PEP 566 added new metadata fieldsincludingDescription-Content-Type.To set the content type for your long description, you’ll need to add thefollowing argument to the setup() call in your projects setup.py:

3. Upgrade your setuptools: #

You’ll need a version of setuptools>=38.6.0 to be able to produce adistribution with the new metadata.

You also must be actually using setuptools. This means that in yoursetup.py you have an import like:

4. Make a source distribution #

This is the same as usual:

You may see a warning from distutils which can be safely ignored:

Note: If you’d like to create a wheel as well, perhaps with python setup.pybdist_wheel, you will need a version of wheel>=0.31.0:

5. Upgrade your twine: #

You must upload the distribution withtwine, and only twine>=1.11.0 willcorrectly send the metadata to PyPI:

6. Upload the distribution: #

This is also the same as usual:

7. View your project on pypi.org#

Visiting your project page on https://pypi.org to see your new Markdowndescription.

Thanks #

Thanks to Marc Abramowitz for originallystarting the push for this feature, to NickCoghlan and DanielHolth for help and guidance with PEP authorshipand reviews, to Tres Seaver, SumanaHarihareswara and Jason R.Coombs for reviewing, testing and releasing pullrequests, and the entire PyPI team including NicoleHarris, Ernest W. DurbinIII and DonaldStufft for being amazing teammates.

Follow me #

Install Markdown Pypi

If you want to stay up to date with all the latest PyPI changes, you can followme: