UNPKG

legal-markdown-js

Version:

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

62 lines 2.11 kB
/** * Header Level Pattern Constants for Legal Markdown * * This module contains the default header patterns used by the auto-population feature * when the CLI --headers flag is used. Users can modify these patterns to customize * the default behavior for their organization or projects. * * For complete documentation on header formats and variable usage, see: * @see {@link ../docs/headers_numbering.md} - Complete guide to headers and numbering system * * @example * ```typescript * import { DEFAULT_HEADER_PATTERNS } from './constants/headers.js'; * * // Use in auto-population * const pattern = DEFAULT_HEADER_PATTERNS['level-1']; // "Article %n." * ``` * * @module */ /** * Default header level patterns following Legal Markdown conventions * * These patterns are used by the YAML auto-population feature when processing * documents with the CLI --headers flag. Each pattern supports template variables: * * - %n: Current level number * - %A: Uppercase letters (A, B, C) * - %a: Lowercase letters (a, b, c) * - %R: Uppercase roman numerals (I, II, III) * - %r: Lowercase roman numerals (i, ii, iii) * - %l1-%l9: Direct level references * - %o: Ordinal numbers (fallback to %n) * * For complete documentation on all available variables and formatting options, * see: docs/headers_numbering.md */ // Default header level patterns aligned with Go/Ruby spec: all levels use '%n.' as fallback. // Users specify 'Article %n.', 'Section %n.', etc. in their document YAML frontmatter. export const DEFAULT_HEADER_PATTERNS = { 'level-1': '%n.', 'level-2': '%n.', 'level-3': '%n.', 'level-4': '%n.', 'level-5': '%n.', 'level-6': '%n.', 'level-7': '%n.', 'level-8': '%n.', 'level-9': '%n.', }; /** * Default properties configuration for YAML auto-population * * These properties control processing behavior and are added to the Properties * section of the YAML front matter when using auto-population. */ export const DEFAULT_PROPERTIES = { 'no-indent': '', 'no-reset': '', 'level-style': '', }; //# sourceMappingURL=headers.js.map