Skip to content

add conventional Markdown content pages rendered as guide docs#109

Merged
daveshanley merged 1 commit into
mainfrom
expanded-docs
Jun 9, 2026
Merged

add conventional Markdown content pages rendered as guide docs#109
daveshanley merged 1 commit into
mainfrom
expanded-docs

Conversation

@daveshanley

Copy link
Copy Markdown
Member

Add EnableContentPages support to PrintingPress: discover conventional Markdown files (about.md, quickstart.md, guide.md, auth.md, docs/*.md) next to a local spec and render them as static guide pages alongside the API reference.

  • New content pipeline: content_loader.go, content_pages.go and markdown_content_rewrite.go handle discovery, frontmatter, partial expansion ({{< partial >}}) with depth/size budgets, image assets, and link rewriting.
  • New render templates for content pages and a content index, plus layout/nav integration (Lit pp-nav guide entries, shared nav cache, CSS) across full and lite bundles.
  • Aggregate mode: aggregate_content_pages.go plus discovery/writer updates publish content pages across multi-spec catalogs.
  • Config validation now distinguishes URL vs local BasePath/SpecPath, only enabling content discovery for local directories and keeping remote spec metadata out of libopenapi's filesystem BasePath.
  • cmd/press flag wiring, pppaths constants, model/catalog additions, and tests for content pages, layout and nav.

Add EnableContentPages support to PrintingPress: discover conventional
Markdown files (about.md, quickstart.md, guide.md, auth.md, docs/*.md)
next to a local spec and render them as static guide pages alongside
the API reference.

- New content pipeline: content_loader.go, content_pages.go and
  markdown_content_rewrite.go handle discovery, frontmatter, partial
  expansion ({{< partial >}}) with depth/size budgets, image assets,
  and link rewriting.
- New render templates for content pages and a content index, plus
  layout/nav integration (Lit pp-nav guide entries, shared nav cache,
  CSS) across full and lite bundles.
- Aggregate mode: aggregate_content_pages.go plus discovery/writer
  updates publish content pages across multi-spec catalogs.
- Config validation now distinguishes URL vs local BasePath/SpecPath,
  only enabling content discovery for local directories and keeping
  remote spec metadata out of libopenapi's filesystem BasePath.
- cmd/press flag wiring, pppaths constants, model/catalog additions,
  and tests for content pages, layout and nav.
@daveshanley daveshanley merged commit 159b409 into main Jun 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant