Skip to content

Commit a5e79e2

Browse files
committed
Implement basic llms.txt support for project docs
1 parent edff652 commit a5e79e2

File tree

3 files changed

+63
-2
lines changed

3 files changed

+63
-2
lines changed

mkdocs.yml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: django-pattern-library
22
repo_url: https://github.com/torchbox/django-pattern-library
3-
site_url:
3+
site_url: https://torchbox.github.io/django-pattern-library/
44
edit_uri: edit/main/docs/
55

66
repo_name: django-pattern-library
@@ -30,6 +30,21 @@ plugins:
3030
- redirects:
3131
redirect_maps:
3232
'reference/related-projects.md': 'community/related-projects.md'
33+
- llmstxt-md:
34+
enable_markdown_urls: true
35+
enable_llms_txt: true
36+
enable_llms_full: true
37+
enable_copy_button: false
38+
sections:
39+
'Getting started':
40+
- index.md
41+
- getting-started.md
42+
'Guides':
43+
- guides/*.md
44+
'Recipes':
45+
- recipes/*.md
46+
'Reference':
47+
- reference/*.md
3348
nav:
3449
- 'Home': 'index.md'
3550
- 'Getting started': 'getting-started.md'

poetry.lock

Lines changed: 46 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ pymdown-extensions = "^10.0"
5555
mkdocs-git-revision-date-plugin = "^0.3.1"
5656
mkdocs-redirects = "^1.0.3"
5757
black = "^25.1.0"
58+
mkdocs-llmstxt-md = "^0.2.0"
5859

5960
[tool.isort]
6061
known_first_party = "pattern_library"

0 commit comments

Comments
 (0)