> For the complete documentation index, see [llms.txt](https://hyperflow.sygnal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hyperflow.sygnal.com/apps/hyperflow-llms/setting-up-markdown-pages.md). # Setting up Markdown Pages {% hint style="success" %} A key reason for the LLMS.TXT standard is to remove unnecesary markup and content from the website, so that it does not consume huge amounts of tokens in the LLM's context window. {% endhint %} To this end, we want to identify key content on our pages. ## Future {% hint style="danger" %} **These customization features are not yet in production.** Currently, Hyperflow LLMS will convert the HTML page exactly to markdown with no special modifications, inclusions, exclusions, or controls. {% endhint %} ## Attributes Body ### hf-llms-mode = ( *page mode* ) {% hint style="danger" %} Reserved for future use. {% endhint %} Place this attribute on the `` element, the topmost element in the designer. Specify one of these page processing modes; * ~~`all` ( default ), Parse the entire page into markdown~~ * `include` - will only include content on the page which is marked for inclusion ( see below ). * `exclude` - will include all content on the page except those sections which are specifically marked for exclusion. {% hint style="info" %} `ignore` is handled the same as `exclude` {% endhint %} ### hf-llms = ( *element mode* ) Place on any element in the page. That element and it contents will be handled according to the page mode and element mode. | | | | | --------- | --------------------------------------------- | - | | `exclude` | Excludes the tagged element in MD generation. | | | | | | | | | | * `exclude` - Excludes the tagged element in MD generation. Future; * `include` - Includes the tagged element in MD generation ( when the mode is exclude ) ### hf-llms-frontmatter = ( frontmatter mode ) {% hint style="info" %} Reserved for future use. {% endhint %} Place on the body element. * `include` ( default ) includes Frontmatter * `exclude` does not generate Frontmatter #### Future Custom to generate cvustom frontmatter from an Embed? | hf-llms-mode | hf-llms = exclude | hf-llms = include | | ------------ | --------------------------------------- | --------------------------------------- | | all | Ignored | Ignored | | include | Excludes this element and its children. | Ignored | | exclude | Ignored | Includes this element and its children. | ## Technical Notes ### Frontmatter Hyperflow LLMS includes Frontmatter on each of the auto-generated Markdown Pages ``` --- Page title Date published Public URL --- ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://hyperflow.sygnal.com/apps/hyperflow-llms/setting-up-markdown-pages.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.