summaryrefslogblamecommitdiffstats
path: root/README.rst
blob: 856856b7741a052494bc901cb395cebe5cdb57b8 (plain) (tree) 
40861fc


c5d4781






































74b8211

c5d4781










e902f7b


c5d4781


1
2

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

41

42
43
44
45
46
47
48
49
50
51

52
53

54
55


                 





































                                                                
                                                             









                                                               

           

                                     
markdown-textwrap
=================

Petite program for text wrapping markdown_ documents.

.. _markdown: https://daringfireball.net/projects/markdown

install
-------

::

   pip3 install markdown-textwrap


usage
-----

::

  # Wrap markdown document to 66 characters.

  $ md-tw -w 66 path/to/doc.md > path/to/doc-wrapped.md

  # Wrap markdown document to 42 characters.

  $ md-tw -w 42 path/to/doc.md > path/to/doc-wrapped.md

caveats
-------

* Sentences will always be separated by a single space.
* Markdown documents with tables / task lists are not supported.


source
------

::

   git clone git://git.ricketyspace.net/markdown-textwrap.git

license
-------

Under `GNU General Public License version 3 or later`__.

.. _gplv3: https://www.gnu.org/licenses/gpl-3.0-standalone.html
__ gplv3_


help / bugs
-----------

Ping rsiddharth <s@ricketyspace.net>.
siddharth ravikumar snafu