Skip to main content

jupyter extension for previewing readme.md files

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


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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file readme-preview-0.4.1.tar.gz.

File metadata

  • Download URL: readme-preview-0.4.1.tar.gz
  • Upload date:
  • Size: 56.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

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

See more details on using hashes here.

File details

Details for the file readme_preview-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: readme_preview-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 60.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

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

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page