Skip to content

A Jupyter notebook extension to render README.md files in the folder view

License

Notifications You must be signed in to change notification settings

vikramsoni2/readme-preview

Repository files navigation

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

About

A Jupyter notebook extension to render README.md files in the folder view

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published