From 1b08b2f362b57d64eeb57b7a0262c34d9580018c Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Mon, 27 Oct 2025 20:33:28 -0700 Subject: [PATCH] Add docs on markdown usage (#50) --- docs/source/advanced-configuration.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/advanced-configuration.rst b/docs/source/advanced-configuration.rst index 1668cbf..b855551 100644 --- a/docs/source/advanced-configuration.rst +++ b/docs/source/advanced-configuration.rst @@ -292,6 +292,11 @@ Your URI template can use the following variables: - ``{suffix}`` - The source file suffix (e.g., ``.rst``, ``.md``) - may be empty if no source file exists - ``{sourcelink_suffix}`` - The suffix from ``html_sourcelink_suffix`` configuration (e.g., ``.txt``) +.. tip:: + Instead of using the default of linking to ``_sources``, you can generate Markdown files from your documentation and link to those in ``llms.txt``. + See this package's `CMake setup `_ for an example of building both HTML and Markdown in parallel. + Note that ``_sources`` is still needed for ``llms-full.txt`` at this time. + .. _integration_examples: Integration Examples