Metadata-Version: 2.4
Name: ziko-st-toc
Version: 2.0.0
Summary: A Streamlit component that generates an interactive Table of Contents (TOC) with smooth scrolling and navigation.
Home-page: https://ziko-st-toc.netlify.app/
Author: zakaria.elalaloui
Author-email: zakarialaoui10@gmail.com
Project-URL: Source, https://github.com/zikojs/ziko-st-toc
Project-URL: Tracker, https://github.com/zikojs/ziko-st-toc/issues
Project-URL: Documentation, https://ziko-st-toc.streamlit.app/
Keywords: streamlit table-of-contents toc navigation zikojs
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: JavaScript
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: streamlit>=0.63
Provides-Extra: devel
Requires-Dist: wheel; extra == "devel"
Requires-Dist: pytest==7.4.0; extra == "devel"
Requires-Dist: playwright==1.48.0; extra == "devel"
Requires-Dist: requests==2.31.0; extra == "devel"
Requires-Dist: pytest-playwright-snapshot==1.0; extra == "devel"
Requires-Dist: pytest-rerunfailures==12.0; extra == "devel"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# ziko-st-toc


[![PyPI version](https://img.shields.io/pypi/v/ziko-st-toc.svg)](https://pypi.org/project/ziko-st-toc/)
[![Downloads](https://img.shields.io/pypi/dm/ziko-st-toc)](https://pypi.org/project/ziko-st-toc/)
[![License](https://img.shields.io/pypi/l/ziko-st-toc.svg)](https://github.com/zikojs/ziko-st-toc/blob/main/LICENSE)
[![Netlify Status](https://api.netlify.com/api/v1/badges/04130c58-4a37-4437-8833-bd019eeb5983/deploy-status)](https://app.netlify.com/projects/ziko-st-toc/deploys)


[![ziko-st-banner](https://github.com/zikojs/ziko-st-toc/blob/main/assets/banner.png?raw=true)](https://github.com/zikojs)


A Streamlit component that generates an interactive Table of Contents (TOC) with smooth scrolling and navigation.

## Showcase

![ziko-st-toc demo](https://raw.githubusercontent.com/zikojs/ziko-st-toc/refs/heads/main/assets/demo.gif)

Visit : https://ziko-st-toc.streamlit.app/

## Installation instructions

```sh
pip install ziko-st-toc
```

## Usage instructions

```python
import streamlit as st

from ziko_st_toc import table_of_contents

st.title('Streamlit Table Of contents')

with st.sidebar:
   table_of_contents()

st.header('Header I')
# Content ..
st.header('Header II')
# Content ..
st.subheader('Sub Header II-1')
# Content ..
st.subheader('Sub Header II-2')
# Content ..
st.subheader('Sub Header II-3')
# Content ..
st.header('Header III')
# Content ..
```

## ⭐️ Show your support <a name="support"></a>

If you appreciate the library, kindly demonstrate your support by giving it a star!<br>
<!-- [![Star](https://img.shields.io/github/stars/zikojs/ziko-st-toc?style=social)](https://github.com/zikojs/ziko-st-toc) -->


## License 
This projet is licensed under the terms of MIT License 
