Skip to content

Commit 49c70ba

Browse files
authored
feat: Auto generate llms.txt + fix mermaid issue (#84)
PR#77 reverted the original implementation of llms.txt because it broke mermaid diagram rendering; this restores the original LLM changes + fixes the mermaid rendering issue by including it as extra-javascript. I also removed a duplicate requirement of mkdocs-macros-plugin Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
1 parent 5ba6814 commit 49c70ba

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

mkdocs.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
site_name: Strands Agents SDK
22
site_description: Documentation for Strands Agents, a simple-to-use, code-first, lightweight library for building AI agents
33
site_dir: site
4+
site_url: https://strandsagents.com
45

56
repo_url: https://github.com/strands-agents/sdk-python
67

@@ -59,6 +60,11 @@ markdown_extensions:
5960
extra_css:
6061
- stylesheets/extra.css
6162

63+
extra_javascript:
64+
# Workaround for site_url breaking mermaid rendering; see the following for more info:
65+
# https://github.com/squidfunk/mkdocs-material/issues/3742#issuecomment-1076068038
66+
- https://unpkg.com/mermaid@11/dist/mermaid.min.js
67+
6268
nav:
6369
- User Guide:
6470
- Welcome: README.md
@@ -146,6 +152,15 @@ plugins:
146152
docstring_style: google
147153
show_root_heading: true
148154
show_source: true
155+
- llmstxt:
156+
sections:
157+
User Guide:
158+
- README.md
159+
- user-guide/**/*.md
160+
Examples:
161+
- examples/**/*.md
162+
API Reference:
163+
- api-reference/*.md
149164

150165
extra:
151166
social:

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ mike~=2.1.3
22
mkdocs~=1.6.1
33
mkdocs-macros-plugin~=1.3.7
44
mkdocs-material~=9.6.12
5-
mkdocs-macros-plugin~=1.3.7
65
mkdocstrings-python~=1.16.10
6+
mkdocs-llmstxt~=0.2.0
77
strands-agents~=0.1.0

0 commit comments

Comments
 (0)