index.yml

YAML98 lines3.2 KB

Copy pathGitHub ↗

1### YamlMime:Landing2title: Pudu Documentation Generator3summary: Publish documentation for Pudu projects. Write articles in Markdown, generate reference pages from the public declarations of your Pudu modules and from OpenAPI descriptions, and ship one static website with navigation, cross references, search, and printable PDF documents. This site is built with it.4metadata:5  uid: home6  description: Turn Markdown articles, Pudu source declarations, and OpenAPI descriptions into a searchable static documentation website.78highlightedContent:9  items:10  - title: What is pudu-lang-docgen?11    itemType: overview12    url: guides/introduction.md13  - title: Build your first site14    itemType: quickstart15    url: guides/quick-start.md16  - title: Basic concepts17    itemType: concept18    url: guides/concepts.md19  - title: Pudu API reference20    itemType: reference21    url: guides/api-reference.md22  - title: Deploy a site23    itemType: deploy24    url: guides/deploying.md25  - title: Releases26    itemType: whats-new27    url: https://github.com/chrismichaelps/pudu-lang-docgen/releases2829conceptualContent:30  title: Explore the documentation31  items:32  - title: Author content33    links:34    - text: Markdown authoring35      url: guides/markdown.md36    - text: Tables of contents37      url: guides/tables-of-contents.md38    - text: Links and cross references39      url: guides/cross-references.md40  - title: Reference content41    links:42    - text: Pudu API reference43      url: guides/api-reference.md44    - text: HTTP API reference45      url: guides/http-api.md46    - text: "Sample: Inventory service"47      url: guides/inventory-service.yml48  - title: Customize and publish49    links:50    - text: Configuration reference51      url: guides/configuration.md52    - text: Templates and theming53      url: guides/templates.md54    - text: Search and SEO55      url: guides/search-and-seo.md56    - text: PDF output57      url: guides/pdf.md58  - title: Command line and library59    links:60    - text: Command-line reference61      url: guides/commands/index.md62    - text: Build a site63      url: guides/commands/build.md64    - text: Preview while writing65      url: guides/commands/serve.md66    - text: Library usage67      url: guides/library.md68    footerLink:69      text: Diagnostics reference70      url: guides/diagnostics.md71  - title: Extend72    links:73    - text: Extensions overview74      url: extensions/index.md75    - text: Templates76      url: extensions/templates.yml77    - text: Packages78      url: extensions/packages.yml79    - text: Tools80      url: extensions/tools.yml8182additionalContent:83  sections:84  - title: Related content85    items:86    - title: Pudu87      summary: The statically typed language pudu-lang-docgen is written in and documents.88      url: https://www.pudu-lang.org/89    - title: pudu-lang-log90      summary: Structured event logging for Pudu. The command line reports its diagnostics through it.91      url: https://github.com/chrismichaelps/pudu-lang-log92    - title: pudu-lang-validator93      summary: Typed validation for Pudu. Configuration files are checked with its rules.94      url: https://github.com/chrismichaelps/pudu-lang-validator95    - title: Source code96      summary: Issues, releases, and the source of pudu-lang-docgen.97      url: https://github.com/chrismichaelps/pudu-lang-docgen98