========================
CODE SNIPPETS
========================
TITLE: Directory Structure Representation
DESCRIPTION: Demonstrates how to represent file and directory hierarchies within a Markdown file using code blocks for clarity. This aids LLMs in understanding project structure.

SOURCE: https://github.com/kongyo2/llmc/blob/main/llmc.md#_snippet_0

LANGUAGE: text
CODE:
```
src/
  cli/
    cliOutput.ts
    index.ts
  config/
    configLoader.ts
index.ts
README.md
```

----------------------------------------

TITLE: Markdown Structure Specification
DESCRIPTION: Details the required sections and formatting rules for an llmc.md file, including title, summary, detailed description, related resources, and optional information.

SOURCE: https://github.com/kongyo2/llmc/blob/main/llmc.md#_snippet_1

LANGUAGE: markdown
CODE:
```
# Project Name

> A concise summary of the project or concept.

## Detailed Description

This section provides in-depth information about the project, its features, design principles, and any important considerations.

## Related Resources

- [Documentation](URL_to_docs): Further details and guides.
- [API Specification](URL_to_api): Information on available APIs.

## Optional

This section contains secondary information that may be omitted if context is limited.
```

----------------------------------------

TITLE: Markdown Formatting Guidelines
DESCRIPTION: Specifies best practices for Markdown formatting within llmc files, emphasizing structure, clarity, and the use of specific elements like code blocks and mermaid diagrams.

SOURCE: https://github.com/kongyo2/llmc/blob/main/llmc.md#_snippet_2

LANGUAGE: markdown
CODE:
```
## Section Title

Use headings (`#`, `##`, `###`) to organize content logically.

*   Use bullet points for lists.
*   Use numbered lists for steps:
    1.  First step
    2.  Second step

```typescript
// Example TypeScript code
function greet(name: string): string {
  return `Hello, ${name}!`;
}
```

**Important Note**: Use bold for emphasis.

```mermaid
graph TD
    A[Start] --> B{Process}
    B --> C[End]
```

---
```