Add view as markdown button #505
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new system to generate and expose plain markdown versions of all documentation pages, optimized for LLM consumption. It adds a custom Docusaurus plugin to automate markdown extraction, creates an index file of all markdown URLs, and enhances the documentation UI with a "View as Markdown" button for direct access. Additional improvements include dependency updates and SEO enhancements.
An example of LLM markdown pages in beaconcha.in:
PR implementation:
In each markdown file, there is now some metadata (title and a little description about the file). This is a docusaurus native functionality that we can use when generating the
llms.txtindexhttps://docusaurus.io/docs/markdown-features/head-metadata
SEO/Robots
robots.txtfile allowing all crawlers and referencing the sitemap, improving site SEO and discoverability. It makes crawlers ignore the .md files taht are for LLMs only