templates.yml

YAML67 lines2.6 KB

Copy pathGitHub ↗

1### YamlMime:Dashboard2title: Templates3description: |4  Templates decide how every page looks. The templates below are built into pudu-lang-docgen5  and are selected by name in `build.template`. Template folders of your own are listed after6  them to override partials and add styles; see [Templates and theming](../guides/templates.md).7items:8- name: default9  description: |10    The standard look: a responsive layout with light, dark, and automatic color themes, a11    header with search, a filterable sidebar, breadcrumbs, an article outline, previous and12    next links, and print styles. Its layout and partials can be exported and overridden.13  type: Template14  author: Chris Michael15  version: 0.1.016  license: Apache-2.017  thumbnail: ../images/pudu-lang-short.png18  homepage: ../guides/templates.html19  repository:20    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Theme/Layout.pudu21  usage:22    config: '"template": ["default", "template"]'23    command: docgen template export template24- name: modern25  description: |26    Another name for `default`, accepted so that configurations that name it keep working.27    It renders exactly like `default`.28  type: Template29  author: Chris Michael30  version: 0.1.031  license: Apache-2.032  thumbnail: ../images/pudu-lang-short.png33  homepage: ../guides/commands/template.html34  repository:35    url: https://github.com/chrismichaelps/pudu-lang-docgen36  usage:37    config: '"template": ["modern"]'38    command: docgen template list39- name: rest.tagpage40  description: |41    A template extension for HTTP API reference. Each OpenAPI description is published as an42    overview page with servers, an operation index, and schemas, plus one page per tag.43  type: Template extension44  author: Chris Michael45  version: 0.1.046  license: Apache-2.047  thumbnail: ../images/pudu-lang-short.png48  homepage: ../guides/http-api.html#splitting-large-services49  repository:50    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Rest/Pages.pudu51  usage:52    config: '"template": ["default", "rest.tagpage"]'53- name: rest.operationpage54  description: |55    A template extension for HTTP API reference that publishes one page per operation. Combine56    it with `rest.tagpage` for tag pages that link to operation pages.57  type: Template extension58  author: Chris Michael59  version: 0.1.060  license: Apache-2.061  thumbnail: ../images/pudu-lang-short.png62  homepage: ../guides/http-api.html#splitting-large-services63  repository:64    url: https://github.com/chrismichaelps/pudu-lang-docgen/blob/main/src/PuduLangDocgen/Rest/Pages.pudu65  usage:66    config: '"template": ["default", "rest.tagpage", "rest.operationpage"]'67