# Documentation

https://vowel.cc/docs

Vowel turns markdown into a feature-rich website.

Here's how Vowel processes files:

- On startup, Vowel builds your whole website, which usually takes a few seconds.
- As it goes, Vowel caches all data and relationships in an SQLite database.
- Any slow tasks, like image formatting and link fetching, runs in the background.
- When any file changes in the build, Vowel sends an update on the localhost socket and the browser udpates the DOM where necessary.
- Link data gets cached in your project files to avoid spammy fetching whenever the cache is cleared.
- If you throw out the cache, Vowel can rebuild it in seconds from your files alone.

Vowel generates your website build on the fly, meaning you always have a folder of static HTML ready to deploy on any website host.

## Agents

Vowel has features for blocking or empowering agents working with your website, depending on your use case.

To block agents, update your site's robots settings (see [Site](https://vowel.cc/docs/guides/site)).

To give agents easy access to your website, turn on `llms.txt` and markdown mirrors (see [Site](https://vowel.cc/docs/guides/site)).

To empower agents to work with your content, `vowel init` will create an `AGENTS.md` file and a Vowel skill in your project folder. You can install the Vowel skill in Claude Code:

```
/plugin install vowel --marketplace samlfair/vowel
```

## Guides

- [Design](https://vowel.cc/docs/guides/design)
- [Files](https://vowel.cc/docs/guides/files)
- [Markdown](https://vowel.cc/docs/guides/markdown)
- [Site](https://vowel.cc/docs/guides/site)

## References

- [votive](https://vowel.cc/docs/references/votive)
- [vowel](https://vowel.cc/docs/references/vowel)
