Project description

readme-preview

A Jupyter notebook extension to render README.md markdown files in the folder view. it loads the github style preview of README.md file if it exist in the current directory.

install python package

pip install readme-preview

Install the notebook extension

jupyter nbextension install --py readme-preview

emable the extension

jupyter nbextension enable --py readme-preview

References

https://github.com/showdownjs/showdown used for converting markdown to HTML for preview

Project details

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Release history Release notifications | RSS feed

This version

0.4.1

Jul 16, 2021

0.4.0

Jul 16, 2021

0.3.0

Jul 16, 2021

0.2.0

Jul 16, 2021

0.1.1

Jul 16, 2021

0.1.0

Jul 15, 2021

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readme-preview-0.4.1.tar.gz (56.3 kB view hashes)

Uploaded Jul 16, 2021 Source

Built Distribution

readme_preview-0.4.1-py3-none-any.whl (60.8 kB view hashes)

Uploaded Jul 16, 2021 Python 3

Hashes for readme-preview-0.4.1.tar.gz

Hashes for readme-preview-0.4.1.tar.gz
Algorithm	Hash digest
SHA256	`3f8f0b5705617d668870fc8853ac278caec487f5366586b01e95a407f846a28f`
MD5	`dae21a38813b414d43431aec20faa64d`
BLAKE2b-256	`0fe362bc053589a54741200427db11a88c606e074bdf6c009a07fcce75638c73`

Hashes for readme_preview-0.4.1-py3-none-any.whl

Hashes for readme_preview-0.4.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1fa2a828ae4f556b30d469bd2abe9da87ed1c1b5348e760d46c0ee9197d4ff21`
MD5	`4336a7f699c4e94136f621fc932e1079`
BLAKE2b-256	`f3c045cf3560ad2d511388be9322c5358b061a96422d2f2efbc65af042d4a5a0`