Add short description to README
This commit is contained in:
29
README.rst
29
README.rst
@@ -0,0 +1,29 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
``pip install markdownify``
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Convert some HTML to Markdown:
|
||||
|
||||
.. code:: python
|
||||
|
||||
from markdownify import markdownify as md
|
||||
md('<b>Yay</b> <a href="http://github.com">GitHub</a>') # > '**Yay** [GitHub](http://github.com)'
|
||||
|
||||
Specify tags to exclude (blacklist):
|
||||
|
||||
.. code:: python
|
||||
|
||||
from markdownify import markdownify as md
|
||||
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', strip=['a']) # > '**Yay** GitHub'
|
||||
|
||||
\...or specify the tags you want to include (whitelist):
|
||||
|
||||
.. code:: python
|
||||
|
||||
from markdownify import markdownify as md
|
||||
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', convert=['b']) # > '**Yay** GitHub'
|
||||
|
||||
Reference in New Issue
Block a user