LLMs.txt

mdui предоставляет llms.txt и llms-full.txt, чтобы передавать LLM (большим языковым моделям) точный контекст, который можно использовать как цитату, и ИИ мог предоставлять более точные и надёжные ответы на вопросы, связанные с mdui.

Использование llms.txt для предоставления контекста ИИ

Два варианта доступа:

• llms.txt: https://www.mdui.org/ru/docs/2/llms.txt
• llms-full.txt: https://www.mdui.org/ru/docs/2/llms-full.txt

llms.txt — это краткий индекс, подходящий для моделей, имеющих доступ к Интернету, которые могут загружать нужные Markdown-страницы по ссылкам, или для получения общего обзора проекта.

llms-full.txt содержит полный контекст, включая всё содержимое страниц из llms.txt, и подходит для случаев, когда модель не имеет доступа к Интернету или когда необходимо предоставить полный контекст целиком.

Markdown-версия документации

Для каждой страницы документации предусмотрена соответствующая Markdown-версия: просто добавьте .md в конец URL страницы (для главной страницы добавьте index.md).

Например:

https://www.mdui.org/ru/docs/2/components/button → https://www.mdui.org/ru/docs/2/components/button.md
https://www.mdui.org/ru/docs/2/ → https://www.mdui.org/ru/docs/2/index.md

Вы можете использовать эту Markdown-ссылку или её текстовое содержимое в качестве контекста для получения более точного ответа.

Как использовать в ChatGPT, Claude и других LLM

В зависимости от того, поддерживает ли модель доступ в Интернет или загрузку файлов, выберите один из следующих способов или их сочетание:

1. Прямая вставка: вставьте содержимое llms-full.txt в качестве системного запроса или первого сообщения.

   Пример: "Ниже приведён контекст mdui. Пожалуйста, строго придерживайтесь его при ответах на последующие вопросы; в случае противоречий приоритет имеет данный контекст:\n\n[вставьте содержимое llms-full.txt]".

2. Загрузка файла: загрузите llms-full.txt (или llms.txt) и в первом сообщении укажите "Используй предоставленную документацию как основной контекст".

   Пример: "На основе предоставленной документации mdui, приведи использование и распространённые ошибки <mdui-button>".

3. Чтение по ссылке: укажите в разговоре ссылку на llms.txt или llms-full.txt.

   Пример: "Пожалуйста, прочитай и используй https://www.mdui.org/ru/docs/2/llms-full.txt в качестве контекста, отвечай на мои вопросы о mdui".

4. Указание на конкретную страницу: если обсуждается только конкретный компонент/функция, просто укажите Markdown-адрес этой страницы.

   Пример: "Пожалуйста, прочитай https://www.mdui.org/ru/docs/2/components/button.md и на основе этого документа приведи три лучшие практики".

Подсказка: Нажмите на иконку в правом верхнем углу страницы, чтобы скопировать соответствующие ссылки, открыть Markdown-версию текущей страницы или открыть текущую страницу или llms-full.txt в ChatGPT в качестве контекста.