Skip to content

Commit 5d6a54d

Browse files
adrianschmidtciving
authored andcommitted
docs: add Context7 configuration for gh-pages indexing
Add context7.json to configure Context7 to index documentation from the gh-pages branch at versions/latest/markdown-docs/. Configuration includes: - Branch targeting: gh-pages (where docs are published) - Folder specification: versions/latest/markdown-docs - Exclusions: build artifacts, assets, and styles - 14 usage rules covering web component patterns, installation, TypeScript support, theming, and common gotchas This enables LLM-based tools to access accurate, version-specific documentation for Lime Elements components.
1 parent 4bf8b53 commit 5d6a54d

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,23 @@ npm start # Starts local development server
173173

174174
---
175175

176+
## AI-Friendly Documentation
177+
178+
Lime Elements generates Context7-compatible markdown documentation to help AI coding assistants and LLMs better understand and use our component library. This documentation is automatically published with each release and includes:
179+
180+
- 📄 **Component API docs** - Detailed markdown documentation for all components
181+
- 📚 **Design guidelines** - Best practices and usage patterns
182+
- 🎯 **Usage rules** - Context7 rules for proper component usage
183+
- 🔗 **Navigation index** - Searchable overview of all components and guides
184+
185+
The documentation is available at:
186+
- **Latest version:** [lundalogik.github.io/lime-elements/versions/latest/markdown-docs/](https://lundalogik.github.io/lime-elements/versions/latest/markdown-docs/)
187+
- **Configuration:** [context7.json](https://github.com/Lundalogik/lime-elements/blob/main/context7.json)
188+
189+
This makes Lime Elements easier to work with when using AI pair programming tools like GitHub Copilot, Cursor, or Claude Code.
190+
191+
---
192+
176193
## 📄 License
177194

178195
Lime Elements is open source software licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

context7.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"$schema": "https://context7.com/schema/context7.json",
3+
"projectTitle": "Lime Elements",
4+
"description": "Modern web component library for enterprise applications built with Stencil. Provides accessible, customizable UI components with comprehensive design system.",
5+
"branch": "gh-pages",
6+
"folders": ["versions/latest/markdown-docs"],
7+
"excludeFolders": [
8+
"versions/latest/build",
9+
"versions/latest/assets",
10+
"versions/latest/style",
11+
"versions/latest/markdown-docs/**/examples"
12+
],
13+
"rules": [
14+
"Lime Elements components are web components built with Stencil",
15+
"Use kebab-case for component tags (e.g., <limel-button>, <limel-input-field>)",
16+
"All components are prefixed with 'limel-'",
17+
"Install via npm: npm install @limetech/lime-elements",
18+
"TypeScript is fully supported with built-in type definitions",
19+
"Components use shadow DOM and work with any framework (React, Vue, Angular, vanilla JS)",
20+
"CSS custom properties are used for theming and customization",
21+
"Icons require setup - components accept icon names that correspond to SVG filenames",
22+
"Most components emit custom events - listen with addEventListener or framework event bindings",
23+
"Components inherit font styles from parent - set font-family on body or parent element",
24+
"Use the --lime-primary-color CSS variable to set the accent color for your application",
25+
"Import components via script tag or module bundler as needed",
26+
"For dark mode support, load color-palette-extended.css from the package",
27+
"All prop names use camelCase in JavaScript/TypeScript but kebab-case in HTML attributes"
28+
]
29+
}

0 commit comments

Comments
 (0)