https://github.com/spragginsdesigns/ai-docs-digest
Tool to combine documentation files and download or copy into a single markdown file for AI consumption.
https://github.com/spragginsdesigns/ai-docs-digest
ai ai-tools markdown-previewer markdown-tools
Last synced: 4 months ago
JSON representation
Tool to combine documentation files and download or copy into a single markdown file for AI consumption.
- Host: GitHub
- URL: https://github.com/spragginsdesigns/ai-docs-digest
- Owner: spragginsdesigns
- Created: 2024-07-29T18:34:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T15:00:04.000Z (9 months ago)
- Last Synced: 2025-01-08T21:28:27.294Z (5 months ago)
- Topics: ai, ai-tools, markdown-previewer, markdown-tools
- Language: JavaScript
- Homepage: https://ai-docs-digest.vercel.app/
- Size: 6.54 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AI Docs Digest
AI Docs Digest is a web-based tool designed to help you combine documentation from various sources into a single, clean Markdown file. This tool is particularly useful for creating comprehensive documentation for AI projects, custom GPTs, or any scenario where you need to consolidate information from multiple pages or sources.
## Features
- Add multiple documentation sections with titles
- Easy-to-use interface for pasting and organizing content
- Combine all sections into a single Markdown file
- Copy combined Markdown to clipboard
- Download combined Markdown as a file
- Dark mode interface for comfortable use
- Automatic saving of sections to local storage
## Getting Started
1. Clone the repository:
```
git clone https://github.com/yourusername/ai-docs-digest.git
cd ai-docs-digest
```
2. Install dependencies:
```
pnpm install
```
3. Run the development server:
```
pnpm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser to use the app.
## Usage
1. Click "Add Section" to create a new section.
2. Give each section a title and paste your documentation content.
3. Add as many sections as needed.
4. Click "Combine Markdown" to merge all sections.
5. Use the "Copy to Clipboard" or "Download Markdown" buttons to export your combined documentation.
## Technologies Used
- Next.js
- React
- Material-UI
- pnpm (Package manager)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.