|  | 
|  | 1 | +--- | 
|  | 2 | +description: LLM-friendly markdown format for notes directories | 
|  | 3 | +globs: notes/**/*.md,**/notes/**/*.md | 
|  | 4 | +alwaysApply: true | 
|  | 5 | +--- | 
|  | 6 | + | 
|  | 7 | +# Instructions for Generating LLM-Optimized Markdown Content | 
|  | 8 | + | 
|  | 9 | +When creating or editing markdown files within the specified directories, adhere to the following guidelines to ensure the content is optimized for LLM understanding and efficient token usage: | 
|  | 10 | + | 
|  | 11 | +1. **Conciseness and Clarity**: | 
|  | 12 | +   - **Be Brief**: Present information succinctly, avoiding unnecessary elaboration. | 
|  | 13 | +   - **Use Clear Language**: Employ straightforward language to convey ideas effectively. | 
|  | 14 | + | 
|  | 15 | +2. **Structured Formatting**: | 
|  | 16 | +   - **Headings**: Utilize markdown headings (`#`, `##`, `###`, etc.) to organize content hierarchically. | 
|  | 17 | +   - **Lists**: Use bullet points (`-`) or numbered lists (`1.`, `2.`, etc.) to enumerate items clearly. | 
|  | 18 | +   - **Code Blocks**: Enclose code snippets within triple backticks (```) to distinguish them from regular text. | 
|  | 19 | + | 
|  | 20 | +3. **Semantic Elements**: | 
|  | 21 | +   - **Emphasis**: Use asterisks (`*`) or underscores (`_`) for italicizing text to denote emphasis. | 
|  | 22 | +   - **Strong Emphasis**: Use double asterisks (`**`) or double underscores (`__`) for bold text to highlight critical points. | 
|  | 23 | +   - **Inline Code**: Use single backticks (`) for inline code references. | 
|  | 24 | + | 
|  | 25 | +4. **Linking and References**: | 
|  | 26 | +   - **Hyperlinks**: Format links using `[Link Text](mdc:URL)` to provide direct access to external resources. | 
|  | 27 | +   - **References**: When citing sources, use footnotes or inline citations to maintain readability. | 
|  | 28 | + | 
|  | 29 | +5. **Avoid Redundancy**: | 
|  | 30 | +   - **Eliminate Repetition**: Ensure that information is not unnecessarily repeated within the document. | 
|  | 31 | +   - **Use Summaries**: Provide brief summaries where detailed explanations are not essential. | 
|  | 32 | + | 
|  | 33 | +6. **Standard Compliance**: | 
|  | 34 | +   - **llms.txt Conformance**: Structure the document in alignment with the `llms.txt` standard, which includes: | 
|  | 35 | +     - An H1 heading with the project or site name. | 
|  | 36 | +     - A blockquote summarizing the project's purpose. | 
|  | 37 | +     - Additional markdown sections providing detailed information. | 
|  | 38 | +     - H2-delimited sections containing lists of URLs for further details. | 
|  | 39 | + | 
|  | 40 | +By following these guidelines, the markdown files will be tailored for optimal LLM processing, ensuring that the content is both accessible and efficiently tokenized for AI applications. | 
|  | 41 | + | 
|  | 42 | +For more information on the `llms.txt` standard, refer to the official documentation: https://llmstxt.org/ | 
0 commit comments