# ASCII Art Heading

Transform your headings into eye-catching ASCII art using FIGlet fonts.

## Usage

Create a code block with the `ascii-art` language identifier:

~~~markdown
```ascii-art
title: HELLO WORLD
```
~~~

### Parameters

| Parameter | Description | Required |
|-----------|-------------|----------|
| `title` | The text to render as ASCII art | Yes |
| `font` | FIGlet font name (see available fonts below) | No |
| `align` | Alignment: `left`, `centre`/`center`, `right` | No |
| `colour` | Colour: hex code (`#ff5500`) or preset (`accent`, `muted`, `warning`, `error`, `success`) | No |

### Example with All Options

~~~markdown
```ascii-art
title: FINANCIALS
font: Banner
align: centre
colour: #7c3aed
```
~~~

## Available Fonts

- Standard (default)
- Banner
- Big
- Slant
- Small
- Block
- Doom
- Lean
- Mini
- Script
- Shadow
- Graffiti
- Ogre
- Poison
- Roman
- Speed
- Straight

## Settings

Access settings via **Settings → Community Plugins → ASCII Art Heading**

- **Default font** - Font used when none specified in code block
- **Font size** - Tiny, Small, Normal, or Large
- **Default colour** - Theme default, accent, or custom hex colour
- **Full width** - Expand beyond readable line width
- **Horizontal scroll** - Enable scrolling for wide ASCII art (prevents wrapping)
- **Show font name** - Display font name below ASCII art

## Installation

### From Community Plugins

1. Open Settings → Community Plugins
2. Disable Safe Mode if prompted
3. Click Browse and search for "ASCII Art Heading"
4. Install and enable the plugin

### Manual Installation

1. Download `main.js`, `manifest.json`, and `styles.css` from the latest release
2. Create a folder called `ascii-art-heading` in your `.obsidian/plugins/` directory
3. Copy the downloaded files into this folder
4. Reload and enable the plugin in Settings → Community Plugins

## Support

If you find this plugin useful, consider supporting its development:

[![Buy Me A Coffee](https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png)](https://buymeacoffee.com/maframpton)

## License

MIT License - see [LICENSE](LICENSE) for details.