Package index • rllmdoc

Unified Interface

Auto-detect project type and generate llms documentation.

llms_document(): Generate llms documentation for a project
use_llm_docs(): Set up LLM documentation workflows for a project
as_project(): Resolve a project into an rllmdoc project object

Generation

Build llms.txt and llms-full.txt from project documentation.

build_llms_docs(): Build llms.txt and llms-full.txt from a project

Validation

Validate individual document frontmatter.

check_quarto_yaml(): Validate a single document's frontmatter

Extraction

Parse document frontmatter and body content.

parse_quarto_yaml(): Parse YAML frontmatter from a document
parse_quarto_body(): Read the body of a document (content after frontmatter)

Migration

Convert existing markdown files to QMD format.

md2qmd(): Convert a markdown file to QMD format