Skip to content

Commit 1db32a0

Browse files
mariotoffiaclaude
andcommitted
pages: add Jekyll front matter to API ref so just-the-docs renders pages
Without front matter, Jekyll treats every generated .md as a static file and copies it verbatim to _site/ instead of rendering it through the just-the-docs layout. The api-reference URLs returned raw markdown (or 404 when the user expected .html). - Add docs/_api-frontmatter.tpl with title, default layout, and nav_exclude:true (the 3,979-page API surface would otherwise drown the sidebar; users reach pages via search and direct links). - Pass --front-matter to xmldocmd in the pages workflow. xmldocmd's $title placeholder is substituted per page; combined with search_exclude:false the pages still get indexed by just-the-docs' search. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 794c7c0 commit 1db32a0

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

.github/workflows/pages.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
mkdir -p docs/api-reference
4848
xmldocmd /tmp/fd-publish/FluentDocker.dll docs/api-reference \
4949
--source https://github.com/mariotoffia/FluentDocker/tree/master/FluentDocker \
50+
--front-matter docs/_api-frontmatter.tpl \
5051
--clean
5152
5253
- name: Setup Ruby

docs/_api-frontmatter.tpl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: $title
3+
layout: default
4+
nav_exclude: true
5+
search_exclude: false
6+
---

0 commit comments

Comments
 (0)