DOCSEARCHbyAlgolia
Submit Docs

Doks Documentation Theme

repository·main·Indexed 25 days ago

https://github.com/thuliteio/doks

A responsive documentation theme for the Thulite static site generator designed for long-form content. Features include FlexSearch integration, dark mode, versioning, i18n support, and built-in blog page support. Requires Node.js LTS and Hugo extended.

Tokens
515
Snippets
2
Records
5
Agent score
31%

What's inside Doks

  1. Overview of Doks features

    main

    Doks is a documentation theme for Thulite that provides several built-in features for documentation sites:

    • Layout: Minimal, responsive layout optimized for documentation.
    • Typography: Easy-to-read typography designed for long-form content.
    • Search: Fully configurable search powered by FlexSearch.
    • Theming: Dark mode and light mode toggle.
    • Code: Syntax highlighting for code blocks.
    • Content Types: Built-in support for blog pages.
    • Localization: Internationalization (i18n) support.
    • Versioning: Support for managing multiple documentation versions.

  3. Design effective reference pages

    main
    Reference pages should be used to outline how features, concepts, or options work in terse and clear terms. Unlike tutorials or guides, reference pages are less concerned with narrative or specific use cases and should instead provide a comprehensive, technical outline of the subject matter to help users find exact answers quickly.

  4. Install Doks using npm

    main

    The recommended way to install the latest version of Doks is by using the npm create command with the thulite package and the doks template. This will scaffold a new project using the Doks documentation theme.

    npm create thulite@latest -- --template doks

  5. Configure SEO metadata for Doks pages

    main

    You can customize SEO settings for individual pages using the params.seo block in the page's front matter. This allows you to control how the page appears in search engines and social media.

    Available keys under params.seo:

    • title: A custom title for the page (optional).
    • description: A custom description for the page (recommended).
    • canonical: A custom canonical URL (optional).
    • robots: Custom robot tags (optional).
    ---
params:
  seo:
    title: ""
    description: ""
    canonical: ""
    robots: ""
---