diff options
author | nathanfdunn <nathanfdunn@gmail.com> | 2020-11-30 19:00:39 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-30 19:00:39 -0500 |
commit | 8e7528fa5c98bf4652deb13206d6e6241d61630b (patch) | |
tree | 741c86c8bc5d91f3f77f1f6c7722b581abd1c3e3 | |
parent | 1279074ea97807c0131a2b82893189bc07bf2dd8 (diff) | |
download | python-markdown-8e7528fa5c98bf4652deb13206d6e6241d61630b.tar.gz |
Add quick start documentation (#1078)
-rw-r--r-- | README.md | 16 |
1 files changed, 13 insertions, 3 deletions
@@ -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>. |