Skip to content

update to support descriptions with file links #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

update to support descriptions with file links #8

wants to merge 3 commits into from

Conversation

logan-markewich
Copy link

This PR adds new config options to provide a description with each page link

sections:
  Usage documentation:
    file1.md: Description of file1
    file2.md: Description of file2

Which would generate something like

- [Page Title](page_url): Description of the page

Added some unit tests, so I think this will work nicely? Open to changes!

adrianlyjak
adrianlyjak reviewed May 10, 2025
View reviewed changes
README.md

```yaml title="mkdocs.yml"
plugins:
- llmstxt:
sections:
Usage documentation:
- index.md
- usage/*.md
index.md: Main documentation page
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you'd need the dashes here still, no? this doesn't look legal on the next line

Copy link
Author

@logan-markewich logan-markewich May 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So from what I understand:

  • if you are using descriptions, this format is correct
  • the old format (just a list using dashes) also still works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adrianlyjak adrianlyjak adrianlyjak approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@logan-markewich @adrianlyjak