legal-markdown-js/dist/generated/llms-txt.js

Node.js implementation of LegalMarkdown for processing legal documents with markdown and YAML - Complete feature parity with Ruby version

/**
 * Generated from ./llms.txt by scripts/generate-llms-module.cjs.
 * Do not edit manually.
 */
export const LLMS_TXT = "# Legal Markdown JS\n\nTypeScript/Node.js implementation of LegalMarkdown for processing legal document templates written in Markdown with YAML frontmatter.\n\n## Overview\n\n- Converts Legal Markdown into processed Markdown, HTML, PDF, DOCX, and metadata exports.\n- Targets legal and structured business documents that need automatic numbering, templating, conditional clauses, imports, and review highlighting.\n- Exposes both a CLI (`legal-md`, `legal-md-ui`, `legal-md-playground`) and a programmatic TypeScript API.\n\n## Core Capabilities\n\n- Parse YAML frontmatter and expose values to templates.\n- Replace variables and evaluate helper functions inside `{{ ... }}` expressions.\n- Process legal headers such as `l.`, `ll.`, `lll.` with automatic numbering and indentation.\n- Render conditional content with bracket syntax and Handlebars-style blocks.\n- Resolve cross-references between sections.\n- Import partial Markdown files with recursive processing and frontmatter merging.\n- Generate HTML, PDF, and DOCX outputs, including highlighted review variants.\n- Track substituted fields and logic branches for document review/debugging.\n- Export merged metadata as YAML or JSON.\n- Support batch and interactive CLI workflows.\n\n## Key Concepts\n\n- Frontmatter: documents typically start with YAML metadata between `---` markers.\n- Variables and helpers: use `{{field}}`, nested paths like `{{client.name}}`, and helper calls such as `{{formatCurrency(amount, currency)}}`.\n- Headers: legal hierarchy uses repeated `l` markers (`l.` to `lllllllll.`) for up to 9 levels.\n- Conditional clauses:\n  - `[content]{condition}`\n  - `{{#if condition}}...{{else}}...{{/if}}`\n  - `{{#variable}}...{{/variable}}`\n- Imports: use `@import path/to/file.md` or quoted paths like `@import \"clauses/standard terms.md\"`.\n- Cross-references: use pipe-based references such as `|reference|` to link sections after numbering is resolved.\n- Frontmatter merging: imported files can contribute metadata; the source document keeps precedence on conflicts.\n- Field tracking: HTML/PDF/DOCX flows can annotate substituted fields and winning logic branches for review output.\n\n## CLI / API\n\n- CLI basic usage: `legal-md [options] [input] [output]`\n- Common CLI outputs:\n  - `legal-md input.md output.md`\n  - `legal-md input.md --html`\n  - `legal-md input.md --pdf`\n  - `legal-md input.md --docx`\n  - `cat input.md | legal-md --stdin --stdout`\n- Important CLI flags:\n  - Processing: `--no-headers`, `--no-clauses`, `--no-references`, `--no-imports`, `--no-mixins`\n  - Review/debug: `--enable-field-tracking`, `--ast-field-tracking`, `--logic-branch-highlighting`, `--debug`\n  - Output: `--html`, `--pdf`, `--docx`, `--highlight`, `--export-yaml`, `--export-json`\n  - PDF backend: `--pdf-connector auto|puppeteer|system-chrome|weasyprint`\n- Main library exports:\n  - `processLegalMarkdown(content, options)`\n  - `generateHtml(content, options)`\n  - `generatePdf(content, outputPath, options)`\n  - `generatePdfVersions(content, outputPath, options)`\n  - `generateDocx(content, outputPath, options)`\n  - `generateDocxVersions(content, outputPath, options)`\n\n## Documentation\n\n- Docs index: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/README.md\n- Getting started: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/getting_started.md\n- CLI reference: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/cli_reference.md\n- Features index: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/README.md\n- YAML frontmatter: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/yaml-frontmatter.md\n- Headers and numbering: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/headers-numbering.md\n- Cross-references: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/cross-references.md\n- Optional clauses: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/optional-clauses.md\n- Conditionals: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/conditionals.md\n- Partial imports: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/partial-imports.md\n- Variables and mixins: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/mixins-variables.md\n- Template loops: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/template-loops.md\n- Date processing: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/date-processing.md\n- Force commands: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/features/force-commands.md\n- Helpers index: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/helpers/README.md\n- Date helpers: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/helpers/date-helpers.md\n- Number helpers: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/helpers/number-helpers.md\n- String helpers: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/helpers/string-helpers.md\n- Math helpers: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/helpers/math-helpers.md\n- Output formats index: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/README.md\n- PDF generation: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/pdf-generation.md\n- HTML generation: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/html-generation.md\n- DOCX generation: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/docx-generation.md\n- Field highlighting: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/field-highlighting.md\n- CSS classes: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/output/css-classes.md\n- Advanced topics: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/advanced/README.md\n- Configuration: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/advanced/configuration.md\n- Batch processing: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/advanced/batch-processing.md\n- Best practices: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/advanced/best-practices.md\n- Processing pipeline: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/processing/README.md\n- Field tracking internals: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/processing/field-tracking.md\n- Architecture overview: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/ARCHITECTURE.md\n- Security notes: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/reference/security.md\n- Troubleshooting: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/docs/reference/troubleshooting.md\n\n## Examples\n\n- Examples index: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/README.md\n- Basic processing walkthrough: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/basic-processing/simple-document/README.md\n- Basic input document: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/basic-processing/simple-document/input.md\n- YAML frontmatter example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/basic-processing/yaml-frontmatter/README.md\n- CLI usage examples: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/integration/cli-usage/README.md\n- Cross-references example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/cross-references/basic-references/README.md\n- Optional clauses example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/optional-clauses/conditional-content/README.md\n- Boolean logic example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/optional-clauses/boolean-logic/README.md\n- Helper functions example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/mixins/helper-functions/README.md\n- Template loops example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/mixins/template-loops/README.md\n- Partial imports example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/imports/partial-imports/README.md\n- Frontmatter merging example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/imports/frontmatter-merging/README.md\n- PDF generation example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/output-formats/pdf-generation/README.md\n- Metadata export example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/output-formats/metadata-export/README.md\n- Advanced NDA example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/advanced/complex-nda/README.md\n- Advanced lease example: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/examples/advanced/office-lease-complete/README.md\n\n## Source Code\n\n- Package metadata: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/package.json\n- Public API entrypoint: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/index.ts\n- CLI entrypoint: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/cli/main.ts\n- CLI service: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/cli/service.ts\n- Interactive CLI: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/cli/interactive/service.ts\n- Core pipeline directory: https://github.com/petalo/legal-markdown-js/tree/main/src/core/pipeline\n- Remark processor: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/extensions/remark/legal-markdown-processor.ts\n- Remark plugins directory: https://github.com/petalo/legal-markdown-js/tree/main/src/plugins/remark\n- Generators directory: https://github.com/petalo/legal-markdown-js/tree/main/src/extensions/generators\n- PDF connector resolver: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/extensions/generators/pdf-connectors/resolver.ts\n- Types: https://raw.githubusercontent.com/petalo/legal-markdown-js/main/src/types.ts\n- Web playground app: https://github.com/petalo/legal-markdown-js/tree/main/src/web\n\n## Notes for AI Agents\n\n- Prefer the docs in `docs/features/` and `docs/helpers/` for syntax details; the README is only the top-level overview.\n- For CLI behavior, treat `docs/cli_reference.md` as the canonical option list.\n- For template syntax, expect a mix of LegalMarkdown-specific constructs (`l.`, `@import`, bracket clauses) and Handlebars-style constructs (`{{field}}`, `{{#if}}`).\n- For output generation, HTML/PDF/DOCX may enable field tracking automatically even when clean Markdown output does not.\n- For import behavior, remember that metadata from imported files merges into the main document, but the source document wins on conflicts.\n- For source-level reasoning, the processing path centers on the remark pipeline and plugins under `src/extensions/remark/` and `src/plugins/remark/`.\n";
//# sourceMappingURL=llms-txt.js.map