Skip to content

Customization

15 pages
  • AI-agent support

    In Customization

    Customization

    An HTML page includes a sidebar, scripts, and styles. A model must remove that shell before it reads the content. OINK can emit the same content as plain Markdown. It provides one .md per page, one llms.txt index at the site root, and a “copy as …

    An HTML page includes a sidebar, scripts, and styles. A model must remove that shell before it reads the content. OINK can emit the same content as plain Markdown. It provides one .md per page, one llms.txt index at the site root, and a “copy as …

  • Print

    In Customization

    Customization

    Printing one page needs no configuration. The sidebar, outline, navbar, and buttons have d-print-none. The browser’s Cmd/Ctrl+P therefore prints only the body. The theme has no per-page “print this page” button. To combine a whole section or book and …

    Printing one page needs no configuration. The sidebar, outline, navbar, and buttons have d-print-none. The browser’s Cmd/Ctrl+P therefore prints only the body. The theme has no per-page “print this page” button. To combine a whole section or book and …

  • Repository links and page info

    In Customization

    Customization

    Repository entries in the action menu use a few github_* parameters. This menu appears at the breadcrumb row’s right end. The “last modified” line at the page end uses Git history. Both features assume that content is in a GitHub-style repository. …

    Repository entries in the action menu use a few github_* parameters. This menu appears at the breadcrumb row’s right end. The “last modified” line at the page end uses Git history. Both features assume that content is in a GitHub-style repository. …

  • Taxonomies

    In Customization

    Customization

    A directory tree gives a page one path. A taxonomy gives it a second. A PostgreSQL backup document can be in an “Operations” directory and on a “backup” tag page. To enable this, set Hugo’s taxonomies: configuration. The theme generates term pages, …

    A directory tree gives a page one path. A taxonomy gives it a second. A PostgreSQL backup document can be in an “Operations” directory and on a “backup” tag page. To enable this, set Hugo’s taxonomies: configuration. The theme generates term pages, …

  • Versions

    In Customization

    Customization

    If a product supports several versions, its documentation usually needs versions too. The theme provides a navbar version switcher and an archive banner on older sites. The site selects the deployment layout. The theme does not build across versions. …

    If a product supports several versions, its documentation usually needs versions too. The theme provides a navbar version switcher and an archive banner on older sites. The site selects the deployment layout. The theme does not build across versions. …

  • Languages

    In Customization

    Customization

    OINK uses Hugo’s multilingual model without adding directory conventions. Configure a languages block. Put each translation beside its original in the same directory, with a language suffix in its filename. This page explains how to convert a …

    OINK uses Hugo’s multilingual model without adding directory conventions. Configure a languages block. Put each translation beside its original in the same directory, with a language suffix in its filename. This page explains how to convert a …

  • Keyboard navigation

    In Customization

    Customization

    OINK’s interactive pages have single-key shortcuts. WASD moves through the sidebar tree. J K move between headings. Q E open previous and next pages. Other shortcuts switch the theme, language, and command palette. Shortcuts are on by default. Typing …

    OINK’s interactive pages have single-key shortcuts. WASD moves through the sidebar tree. J K move between headings. Q E open previous and next pages. Other shortcuts switch the theme, language, and command palette. Shortcuts are on by default. Typing …

  • Command palette

    In Customization

    Customization

    The command palette provides one modal dialog for page search and site actions. Use it to copy page Markdown, switch language or version, and open site links. The theme assembles it with local search. If params.offline_search is off, the page has no …

    The command palette provides one modal dialog for page search and site actions. Use it to copy page Markdown, switch language or version, and open site links. The theme assembles it with local search. If params.offline_search is off, the page has no …

  • Search

    In Customization

    Customization

    OINK uses local search. Hugo generates one JSON index per language at build time. The reader’s browser downloads the index and runs the search locally. Search requires no crawler, account, CDN, or external search service. It is off by default. Enable …

    OINK uses local search. Hugo generates one JSON index per language at build time. The reader’s browser downloads the index and runs the search locally. Search requires no crawler, account, CDN, or external search service. It is off by default. Enable …

  • Layouts and page types

    In Customization

    Customization

    This page describes the page shell. Configure sidebar visibility and width, outline depth, and list or card styles for section indexes. For content locations, see Organizing content. The rule is that the shell follows type, not the path. …

    This page describes the page shell. Configure sidebar visibility and width, outline depth, and list or card styles for section indexes. For content locations, see Organizing content. The rule is that the shell follows type, not the path. …

  • Customization

    In Customization

    Customization

    Use this section to configure site parameters in hugo.yml, data files under data/, and style entry points under assets/. To write individual pages and their front matter, see Authoring. Find it by what you want to change What you want to change Page …

    Use this section to configure site parameters in hugo.yml, data files under data/, and style entry points under assets/. To write individual pages and their front matter, see Authoring. Find it by what you want to change What you want to change Page …

  • Navigation and menus

    In Customization

    Customization

    This page covers the ways a reader moves between pages: the navbar menu, the section switcher, breadcrumbs, page actions, previous / next, and the footer. The sidebar tree and the outline belong to Layouts and page types. The navbar comes from Hugo’s …

    This page covers the ways a reader moves between pages: the navbar menu, the section switcher, breadcrumbs, page actions, previous / next, and the footer. The sidebar tree and the outline belong to Layouts and page types. The navbar comes from Hugo’s …

  • Home and landing pages

    In Customization

    Customization

    Configure home page content in a data file. The sections list in data/home/<language>.yaml sets the sections and their order from top to bottom. The theme finds each section’s content by name in the same file. An ordinary page with layout: landing …

    Configure home page content in a data file. The sections list in data/home/<language>.yaml sets the sections and their order from top to bottom. The theme finds each section’s content by name in the same file. An ordinary page with layout: landing …

  • Brand and appearance

    In Customization

    Customization

    This page assumes the site already builds (Quick start). Configure the name, logo, page width, and footer in hugo.yml. To select an existing system or site font, use params.ui.fonts. Section accent colors also have configuration keys. Add icons under …

    This page assumes the site already builds (Quick start). Configure the name, logo, page width, and footer in hugo.yml. To select an existing system or site font, use params.ui.fonts. Section accent colors also have configuration keys. Add icons under …

  • Configuration

    In Customization

    Customization

    This page is the complete reference for site-level parameters in hugo.yml. Every key that the theme reads appears in a table below with its type, default, short description, and a link to its dedicated guide for copy-ready examples. For page-level …

    This page is the complete reference for site-level parameters in hugo.yml. Every key that the theme reads appears in a table below with its type, default, short description, and a link to its dedicated guide for copy-ready examples. For page-level …