Skip to content

Commit

Permalink
Add quick start documentation (Python-Markdown#1078)
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanfdunn authored Dec 1, 2020
1 parent 1279074 commit 8e7528f
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,19 @@ supported by the [Available Extensions][].
Documentation
-------------

Installation and usage documentation is available in the `docs/` directory
of the distribution and on the project website at
<https://Python-Markdown.github.io/>.
```bash
pip install markdown
```
```python
import markdown
html = markdown.markdown(your_text_string)
```

For more advanced [installation] and [usage] documentation, see the `docs/` directory
of the distribution or the project website at <https://Python-Markdown.github.io/>.

[installation]: https://python-markdown.github.io/install/
[usage]: https://python-markdown.github.io/reference/

See the change log at <https://Python-Markdown.github.io/change_log>.

Expand Down

0 comments on commit 8e7528f

Please sign in to comment.