Skip to content

Commit 3e82ab2

Browse files
committed
Add mentions of theme settings and header/footer as supported catalog files in the contributor documentation
1 parent 285b188 commit 3e82ab2

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

Sources/SwiftDocC/SwiftDocC.docc/SwiftDocC.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ DocC comes with built-in support for several types of input files. You organize
1111
- Tutorial files that include dynamic, learning content.
1212
- Asset files like images, videos, and archived projects for download.
1313
- An `Info.plist` file that contains metadata about the documentation catalog.
14+
- A pair of `header.html` and `footer.html` files to use as a custom header and footer for the rendered output.
15+
- A `theme-settings.json` with theming customizations for the rendered output.
1416

1517
SwiftDocC provides the APIs you use to load a documentation catalog, parse the symbol-graph meta-information, extract symbol documentation, and optionally pair that symbol documentation with external file content. DocC represents the compiled documentation in an in-memory model that you can further convert in a persistable representation for writing to disk.
1618

Sources/SwiftDocC/SwiftDocC.docc/SwiftDocC/CompilerPipeline.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ When a ``DocumentationWorkspaceDataProvider`` find as documentation catalog, it
2121
- Authored markup files with an `.md` extension.
2222
- Authored tutorial files with a `.tutorial` extension.
2323
- Additional documentation assets with known extensions like `.png`, `.jpg`, `.mov`, and `.zip`.
24+
- A pair of `header.html` and `footer.html` files to use as a custom header and footer for the rendered output.
25+
- A `theme-settings.json` with theming customizations for the rendered output.
2426

2527
You can organize the files in any way, as long as the `Info.plist`, `header.html`, `footer.html`, and `theme-settings.json` files are the root of the catalog directory tree.
2628
Here is an example of a documentation catalog that groups topic files in logical groups with an additional directory for shared asset files:

0 commit comments

Comments
 (0)