Metadata-Version: 2.1
Name: nbindex-jupyter
Version: 0.2.25
Summary: Javascript based Jupyter Notebook additions (Table of Content, hide code, Figure numbers, ...)
Home-page: https://github.com/l-althueser/nbindex-jupyter
Author: Lutz Althüser
Author-email: coding@l-althueser.de
License: BSD 3-Clause License
Description: # Index for Jupyter notebooks
        `nbindex` is a small package containing several Javascript additions for Jupyter
        notebooks like a Table of Content or a Code Hider. These additions are designed
        to be executed in a notebook cell so that the added HTML and Javascript functions
        will remain hidden in the cell output and can be exported by the regular HTML
        export of Jupyter.
        
        ## Installation
        
            pip install nbindex-jupyter
        
        ## Usage
        
        ### Table of Content and Code Hider
        
            from nbindex import inline
            inline.tableofcontent()
            inline.codehider()
        
        ![inline.png](examples/inline.png)
        
            from nbindex import floating
            floating.tableofcontent()
            floating.codehider()
        
        ![floating.png](examples/floating.png)
        
        ### Numbered objects (Figures, ...)
        
            from nbindex import numbered
            numbered.Figure()
            numbered.Figure("This is a nice Figure.")
            numbered.object("Figure")
        
        ![numbered.png](examples/numbered.png)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: IPython
Classifier: Framework :: Jupyter
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
