Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of markdown usage in documentation #177

Open
Vamoss opened this issue Mar 30, 2020 · 1 comment
Open

Add example of markdown usage in documentation #177

Vamoss opened this issue Mar 30, 2020 · 1 comment

Comments

@Vamoss
Copy link

Vamoss commented Mar 30, 2020

I couldn't find a dedicated page showing what formatting options are supported.

Example:

# Title
## Subtitle
### Sub-title
--- rule
*italic*
**bold**
[link text](http://url.example.com)
![image label](https://url.example.com/image.png)
<img src="https://url.example.com/image.png" width="100%" alt="image label" />
* list1
* list2
@Vamoss Vamoss changed the title Add example of usage in documentation Add example of markdown usage in documentation Apr 10, 2020
@Pyvonix
Copy link

Pyvonix commented Apr 23, 2020

In fact, markdown is a "normalized language" with a defined syntax (except if you decide to extend it).

By seeing the source code of markdownx you can see the following import: from markdown import markdown, who refer you Python-Markdown package. You have a great tutorial page how explains every native feature than you can use/enable. I advise you to take a look and if there is a need for further explanation don't hesitate to ask.

Maybe a line in the documentation to refer to the official Python Markdown documentation can help users?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants