Skip to content

Roadmap

Roadmap

v0.1 (Released)

  • Single file include directive (<!-- @include: path -->)
  • Recursive include resolution (included files may themselves contain include directives)
  • Circular include detection (circular references produce a build error)
  • Code fence passthrough (include directives inside fenced code blocks are treated as literal text)
  • Multiple output targets via docsgen.yaml
  • README, CLAUDE.md, AGENTS.md generation
  • Link path rewriting — relative links and image URLs in all processed files are rewritten to be correct relative to the output file location

v0.2 (Release)

  • Heading level adjustment — optional level=±N parameter on include directives shifts the heading depth of included content (e.g. <!-- @include: file.md level=+1 -->)
  • Directory include (<!-- @include: docs/dir/ -->) — include all .md files in a directory (sorted by filename)
  • Glob include (<!-- @include: docs/*.md -->) — include files matching a glob pattern
  • Recursive glob include (<!-- @include: docs/**/*.md -->) — include files matching a recursive glob; ** matches zero or more path segments

v0.3 (Release)

  • validate command — dry-run over all templates; reports unresolvable includes without writing output files; exits non-zero on failure
  • include command — expand includes in a given file and print to stdout (debugging tool)
  • version command — print the build version

v0.4

  • ssot validator

v0.5

  • Diff / up-to-date check — exit non-zero if generated files differ from committed versions (CI use)
  • Dry-run mode — preview changes without writing output files
  • Watch mode — automatically rebuild on source file changes
  • Variable substitution — allow placeholders expanded at build time
  • Front matter support — parse and strip/merge YAML front matter from included files
  • Conditional includes — include or exclude sections based on build-time flags

v0.6

  • HTML output — convert generated Markdown to HTML
  • PDF output — convert generated Markdown to PDF
  • TOC generation — automatically insert a table of contents