Skip to content

Improve Leadtype docs pipeline readability #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KayleeWilliams merged 3 commits into from
May 11, 2026
Merged

Improve Leadtype docs pipeline readability #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
104f79f
Improve Leadtype docs pipeline readability
KayleeWilliams May 11, 2026
d64b62d
Polish docs nav and readability
KayleeWilliams May 11, 2026
507f21c
Disable jiti module cache for docs.config reloads
KayleeWilliams May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ flowchart LR
src["docs/*.mdx"]
site_run["leadtype generate"]
bundle_run["leadtype generate --bundle"]
site_out["public/<br/>llms.txt · llms-full/<br/>docs/*.md · search-index.json"]
site_out["public/<br/>llms.txt · llms-full.txt<br/>docs/*.md · search-index.json"]
bundle_out["packages/&lt;name&gt;/<br/>AGENTS.md · docs/*.md"]
humans["humans (browser)"]
http_agents["HTTP agents<br/>(/llms.txt or<br/>Accept: text/markdown)"]
Expand All @@ -28,7 +28,7 @@ leadtype is **not a docs website framework**. Bring your own UI — Next.js, Tan
## Choose your path

- **[Build a docs site](https://leadtype.dev/docs/build/connect-docs-site)** — wire leadtype into your build to convert MDX, index search, and serve markdown to agents.
- **[Bundle docs into your package](https://leadtype.dev/docs/build/bundle-package-docs)** — ship `AGENTS.md` plus topic markdown inside the npm tarball so coding agents auto-discover them from `node_modules/<your-package>/AGENTS.md`.
- **[Bundle docs into your package](https://leadtype.dev/docs/package-docs/bundle)** — ship `AGENTS.md` plus topic markdown inside the npm tarball so consumers can point agents at version-matched docs in `node_modules/<your-package>/`.

## Install

Expand All @@ -50,14 +50,17 @@ For an npm-bundled doc set:
npx leadtype generate --bundle --src . --out packages/my-package
```

The first produces `public/llms.txt`, `public/docs/llms-full/*.txt`, `public/docs/search-index.json`, and `public/docs/*.md`. The second produces `packages/my-package/AGENTS.md` and `packages/my-package/docs/*.md` — auto-discoverable by [25+ coding agents](https://agents.md) once the package is installed.
The first produces `public/llms.txt`, `public/llms-full.txt`, `public/docs/search-index.json`, and `public/docs/*.md`. The second produces `packages/my-package/AGENTS.md` and `packages/my-package/docs/*.md` with relative links that still work after npm install.

## Documentation

Full docs at [leadtype.dev](https://leadtype.dev/docs):

- [Quickstart](https://leadtype.dev/docs/quickstart)
- [How it works](https://leadtype.dev/docs/how-it-works)
- [Build a docs site](https://leadtype.dev/docs/build/connect-docs-site)
- [Bundle docs into your package](https://leadtype.dev/docs/package-docs/bundle)
- [Add search](https://leadtype.dev/docs/build/add-search)
- [Frontmatter](https://leadtype.dev/docs/authoring/frontmatter)
- [CLI reference](https://leadtype.dev/docs/reference/cli)
- [Methodology](https://leadtype.dev/docs/methodology) — how leadtype differs from Fumadocs, Starlight, and Mintlify
Expand Down
Loading
Loading