Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reddit/snudown
reddit's markdown renderer. based on sundown.
https://github.com/reddit/snudown
Last synced: 3 months ago
JSON representation
reddit's markdown renderer. based on sundown.
- Host: GitHub
- URL: https://github.com/reddit/snudown
- Owner: reddit
- Created: 2011-10-14T18:31:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2023-07-23T14:20:17.000Z (over 1 year ago)
- Last Synced: 2024-08-01T21:41:08.406Z (7 months ago)
- Language: C
- Homepage:
- Size: 377 KB
- Stars: 181
- Watchers: 100
- Forks: 78
- Open Issues: 22
-
Metadata Files:
- Readme: README.markdown
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-github-repos - reddit/snudown - reddit's markdown renderer. based on sundown. (C)
README
Snudown
=======
`Snudown` is a reddit-specific fork of the [Sundown](http://github.com/vmg/sundown)
Markdown parser used by GitHub, with Python integration added.
Setup for development on Mac OS X
--------------------------------
1. From `~/src/snudown` run `$ python setup.py build`
2. If this is successful, there will now be a `snudown.so` file in the `/snudown/build/lib.< os info >-< python version number>` directory
3. From within the `/lib.< os info >-< python version number>` directory, start a python interpreter
```
>>> import snudown
>>> print(snudown.__file__)
snudown.so
>>> snudown.markdown('[hi](http://www.reddit.com)')
'
\n'
>>> quit()
```
4. Verify that the tests pass
```
$ PYTHONPATH="$(pwd)" python ../../test_snudown.py
```
5. Verify that all the previous steps work for both Python 2 AND Python 3
Install for general use
-----------------------
Run `setup.py install` to install the module.
For Mac OS X:
1. Install `afl-fuzz` via homebrew: `brew install afl-fuzz`
2. You can now install the module via `python setup.py install`
3. You may also compile snudown using the Makefile directly if you so wish
Thanks
------
Many thanks to @vmg for implementing the initial version of this fork!
License
-------
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.