Skip to content

Commit 1d87e1a

Browse files
joerdava-h
andauthored
feat(docs): add llms.md (#1023)
Co-authored-by: Adrian Hesketh <adrianhesketh@hushmail.com>
1 parent c36a9e1 commit 1d87e1a

File tree

9 files changed

+24
-8
lines changed

9 files changed

+24
-8
lines changed

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@
1818
npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
21+
22+
/static/llms.md

docs/docs/09-commands-and-tools/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/docs/09-commands-and-tools/01-cli.md renamed to docs/docs/09-developer-tools/01-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Command-line tools
1+
# CLI
22

33
`templ` provides a command line interface. Most users will only need to run the `templ generate` command to generate Go code from `*.templ` files.
44

File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Coding assistants / LLMs
2+
3+
To provide AI coding assistants such as Github Copilot, Cursor or similar with help on how to write templ code, the templ project maintains a single file containing documentation for LLMs to read.
4+
5+
You can find the file at `https://templ.guide/llms.md`.
6+
7+
## LLM tools
8+
9+
### https://github.com/CopilotC-Nvim/CopilotChat.nvim
10+
11+
CopilotChat is a plugin for Neovim that provides a chat interface for Github Copilot. It allows you to ask Copilot questions and get responses in real-time.
12+
13+
Use the URL feature to load `https://templ.guide/llms.md`.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"position": 9,
3+
"label": "Developer tools"
4+
}

docs/package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
7-
"start": "docusaurus start",
8-
"build": "docusaurus build",
7+
"start": "npm run generate-llms-md && docusaurus start",
8+
"build": "npm run generate-llms-md && docusaurus build",
99
"swizzle": "docusaurus swizzle",
1010
"deploy": "docusaurus deploy",
1111
"clear": "docusaurus clear",
1212
"serve": "docusaurus serve",
1313
"write-translations": "docusaurus write-translations",
14-
"write-heading-ids": "docusaurus write-heading-ids"
14+
"write-heading-ids": "docusaurus write-heading-ids",
15+
"generate-llms-md": "find docs | grep '.*md$' | xargs cat > ./static/llms.md"
1516
},
1617
"dependencies": {
1718
"@docusaurus/core": "^3.5.2",

0 commit comments

Comments
 (0)