Metadata-Version: 2.2
Name: kapsula
Version: 0.2.1
Summary: Great for adding markdown docs to llm. Dead simple docs generator. Originally used at Metabob.com
Author: ARJ
Project-URL: Homepage, https://github.com/Abdur-RahmaanJ/kapsula
Project-URL: Documentation, https://github.com/Abdur-RahmaanJ/kapsula
Project-URL: Source Code, https://github.com/Abdur-RahmaanJ/kapsula
Project-URL: Bug Tracker, https://github.com/Abdur-RahmaanJ/kapsula/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Description-Content-Type: text/markdown
License-File: LICENSE

<div align=center width=150>

  ![](https://raw.githubusercontent.com/Abdur-rahmaanJ/kapsula/stable/assets/logo.png)
  
</div>

# kapsula

Great for adding markdown docs to llm.

Dead simple docs generator. Generates html and markdown docs. 

Have a clear view of the codebase without knowing any tooling

```
python -m kapsula . # path to folder
python -m kapsula path/ --exclude venv another_folder # excludes folders, venv excluded by default
python -m kapsula /path --debug # debug
python -m kapsula [directories] [output.html] [output.md] [flags]
python -m kapsula scripts buns docs.html docs.md --exclude venv
```

Makes onboarding a breeze!


## Generated Doc

- Treeview

![](https://raw.githubusercontent.com/Abdur-rahmaanJ/kapsula/stable/assets/tree_view.png)

- List view

![](https://raw.githubusercontent.com/Abdur-rahmaanJ/kapsula/stable/assets/list_view.png)

- Search

![](https://raw.githubusercontent.com/Abdur-rahmaanJ/kapsula/stable/assets/search.png)
