Skip to content

Authoring

9 pages
  • API reference pages

    In Authoring

    Authoring

    An API reference page is one OpenAPI specification plus one shortcode. Choose Swagger UI when readers need to try requests, or Redoc for browsing endpoint descriptions and schemas. Both runtimes ship with the theme and load only on pages that use …

    An API reference page is one OpenAPI specification plus one shortcode. Choose Swagger UI when readers need to try requests, or Redoc for browsing endpoint descriptions and schemas. Both runtimes ship with the theme and load only on pages that use …

  • Releases and downloads

    In Authoring

    Authoring

    OINK stores release metadata in two local places: a page’s front matter release_url identifies its GitHub release, and data/download/<key>.yaml records installation instructions. Release cards, asset tables, download blocks, and index pages derive …

    OINK stores release metadata in two local places: a page’s front matter release_url identifies its GitHub release, and data/download/<key>.yaml records installation instructions. Release cards, asset tables, download blocks, and index pages derive …

  • Image albums with Expo

    In Authoring

    Authoring

    Expo displays image collections as albums. A sidebar groups the albums. The main area shows the images in the selected album. Each image opens in a viewer. Available in OINK 1.3.0 Expo is included in OINK v1.3.0. Open the example albums to try the …

    Expo displays image collections as albums. A sidebar groups the albums. The main area shows the images in the selected album. Each image opens in a viewer. Available in OINK 1.3.0 Expo is included in OINK v1.3.0. Open the example albums to try the …

  • Books

    In Authoring

    Authoring

    A book is a content tree with type: book. The directory determines chapter order. Front matter determines chapter numbers. Each figure, table, equation, and example has a manually assigned number and stable anchor. Cross-references resolve in all …

    A book is a content tree with type: book. The directory determines chapter order. Front matter determines chapter numbers. Each figure, table, equation, and example has a manually assigned number and stable anchor. Cross-references resolve in all …

  • Blog posts

    In Authoring

    Authoring

    Write a blog post’s body like a documentation page. The shell differs. A post has a date, author, tags, and featured image. The list uses date order, newest first. The section has an RSS feed. This page covers creating the blog section, a post’s …

    Write a blog post’s body like a documentation page. The shell differs. A post has a date, author, tags, and featured image. The list uses date order, newest first. The section has an RSS feed. This page covers creating the blog section, a post’s …

  • Page parameters

    In Authoring

    Authoring

    This page lists all page-level parameters that OINK reads, including explicit 1.x compatibility no-ops. It omits keys that the theme reads only to warn about a rename or removal. Those keys are in Migration, and they are also kept out of the …

    This page lists all page-level parameters that OINK reads, including explicit 1.x compatibility no-ops. It omits keys that the theme reads only to warn about a rename or removal. Those keys are in Migration, and they are also kept out of the …

  • Authoring

    In Authoring

    Authoring

    This section covers all content types supported by OINK: documentation pages, blog posts, books, Expo image albums, release and download pages, and OpenAPI references. They share a single Markdown dialect and front matter schema, while each content …

    This section covers all content types supported by OINK: documentation pages, blog posts, books, Expo image albums, release and download pages, and OpenAPI references. They share a single Markdown dialect and front matter schema, while each content …

  • Organizing content

    In Authoring

    Authoring

    OINK requires no separate navigation configuration. The directory structure under content/ creates the sidebar tree. This page covers how directories and files are arranged, section indexes, ordering, icons, folding, hiding, and multiple sidebar …

    OINK requires no separate navigation configuration. The directory structure under content/ creates the sidebar tree. This page covers how directories and files are arranged, section indexes, ordering, icons, folding, hiding, and multiple sidebar …

  • Writing pages

    In Authoring

    Authoring

    This page covers the complete process for writing a documentation page. It explains file location, front matter, heading anchors, links, images, drafts, and page-end controls. The site must already build locally. If it does not, start with Quick …

    This page covers the complete process for writing a documentation page. It explains file location, front matter, heading anchors, links, images, drafts, and page-end controls. The site must already build locally. If it does not, start with Quick …