https://github.com/timscodebase/doc-2-llm
https://github.com/timscodebase/doc-2-llm
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/timscodebase/doc-2-llm
- Owner: timscodebase
- Created: 2025-03-23T20:57:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-23T22:18:44.000Z (about 1 year ago)
- Last Synced: 2025-04-01T23:41:55.827Z (about 1 year ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docs to LLM (doc-2-llm)
Effortlessly generate Svelte-style documentation for your projects with **doc-2-llm** – the NPM package that bridges your code to LLM-friendly formats! Inspired by Svelte's own [llms-small.txt](https://svelte.dev/llms-small.txt), this tool creates both human-readable markdown documentation and minimized text files optimized for language models.
## Overview
**doc-2-llm** simplifies the process of generating documentation for SvelteKit projects (and beyond). It produces two key outputs:
- `project_documentation.md`: A comprehensive markdown file with a table of contents and code blocks for easy navigation.
- `[project-name]-llm.txt`: A minimized text file in the "llms-small.txt" format, with each file's content prefixed by `/// file: [path]`, preserving whitespace for LLM compatibility.
Whether you're a Svelte developer looking to streamline your documentation or a team integrating AI-driven workflows, **doc-2-llm** ensures your project is ready for the next generation of development tools.
## Installation
Install **doc-2-llm** globally using npm:
```bash
npm install -g doc-2-llm