Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
emarquezz authored Oct 15, 2024
1 parent d71abbc commit 658303b
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,35 @@
[![PyPI Version](https://img.shields.io/pypi/v/cutiepynb.svg)](https://pypi.python.org/pypi/cutiepynb)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/cutiepynb.svg)](https://anaconda.org/conda-forge/cutiepynb)
![Run Python Tests](https://github.com/emarquezz/cutiepynb/actions/workflows/python-tests.yml/badge.svg)
![macOS Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/macos.yml/badge.svg)
![Ubuntu Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/ubuntu.yml/badge.svg)
![Windows Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/windows.yml/badge.svg)

**Turn your Jupyter Notebooks into beautiful, colorful cutie ipynb with cutiepynb!**
**Turn your Jupyter Notebooks into beautiful, colorful cutie ipynb with cutiepynb!**
Dress them up with vibrant title colors and an auto-generated table of contents.

- **License:** [MIT License](LICENSE)
- **Documentation:** [cutiepynb Docs](https://emarquezz.github.io/cutiepynb)

## Features
## Features

- Customizable title colors for notebook headings.
- Automatic table of contents generation.
- Supports dynamic updates to heading styles.
- Works seamlessly with various seaborn color palettes.
- 🎨 **Customizable title colors** for notebook headings.
- 📚 **Automatic table of contents generation**.
- 🔄 **Supports dynamic updates** to heading styles.
- 🌈 **Works seamlessly with various seaborn color palettes**.

## Installation

You can install `cutiepynb` via pip:

```bash
pip install cutiepynb
```

## Examples
To see `cutiepynb` in action, run the following script to process example notebooks:
```bash
python run_examples.py

To see cutiepynb in action, run the following script to process example notebooks:

```bash
python run_examples.py
```

0 comments on commit 658303b

Please sign in to comment.