llms.txt
Compare with other sites' llms.txt files →# Doks
> Build a fast, accessible documentation website with Doks, including practical defaults, flexible components, and an efficient authoring workflow.
- [Doks](https://getdoks.org/docs/): Learn how Doks helps you build polished documentation sites with clear setup steps, practical defaults, and a smooth path from scaffold to launch.
- [Showcase](https://getdoks.org/showcase/): Explore real-world websites built with Doks and discover how teams use its documentation tools, flexible components, and Hugo foundation across varied projects.
- [Blog](https://getdoks.org/blog/): Read Doks release notes, product updates, and practical articles covering new features, improvements, and guidance for building documentation websites.
## Doks
> Learn how Doks helps you build polished documentation sites with clear setup steps, practical defaults, and a smooth path from scaffold to launch.
- [Start Here](https://getdoks.org/docs/start-here/): Start with Doks through a guided path covering installation, configuration, daily usage, verification, updates, and troubleshooting.
- [Basics](https://getdoks.org/docs/basics/): Learn Doks basics, from content and layouts to assets, integrations, templates, and deployment, so you can build and ship sites confidently.
- [Advanced](https://getdoks.org/docs/advanced/): Explore advanced Doks topics for performance, security, SEO, analytics, CMS integration, and multilingual sites to improve production readiness.
- [Reference](https://getdoks.org/docs/reference/): Use this reference section to quickly find authoritative details on Thulite CLI, commands, configuration fields, and Markdown syntax behavior.
### Start Here
> Start with Doks through a guided path covering installation, configuration, daily usage, verification, updates, and troubleshooting.
- [Getting Started](https://getdoks.org/docs/start-here/getting-started/): Get oriented with Doks' core goals, required prerequisites, and the next documentation steps to install, configure, use, and maintain your site.
- [Installation](https://getdoks.org/docs/start-here/installation/): Create a new Doks project with the CLI, choose a template and variant, and bootstrap a ready-to-run site with optional integrations.
- [Configuration](https://getdoks.org/docs/start-here/configuration/): Configure Doks by updating Hugo settings, project parameters, and page frontmatter, then apply integration-specific options when needed.
- [Usage](https://getdoks.org/docs/start-here/usage/): Follow the day-to-day Doks workflow to create content, run the dev server, format files, build production output, and preview locally.
- [Verification](https://getdoks.org/docs/start-here/verification/): Verify your Thulite build by checking generated HTML, assets, metadata, and runtime behavior before deployment with browser and audit tools.
- [Updating](https://getdoks.org/docs/start-here/updating/): Navigate Doks update guidance, including release tracking, semantic versioning, and upgrade paths for keeping projects current and stable.
- [Troubleshooting](https://getdoks.org/docs/start-here/troubleshooting/): Troubleshoot common Thulite issues by validating configuration, checking integration docs, and using GitHub issues and discussions for support.
- [Editor Setup](https://getdoks.org/docs/start-here/editor-setup/): Set up your editor for Thulite with recommended VS Code extensions and formatting commands to keep Markdown, styles, and scripts consistent.
#### Updating
> Navigate Doks update guidance, including release tracking, semantic versioning, and upgrade paths for keeping projects current and stable.
- [Updating Overview](https://getdoks.org/docs/start-here/updating/updating-overview/): Learn how to update Doks, track release changes, and use semantic versioning to plan safe upgrades across patch, minor, and major releases.
- [V2](https://getdoks.org/docs/start-here/updating/v2/): Migrate from Doks v1 to v2 with step-by-step dependency, package, and configuration updates, plus fixes for common upgrade issues.
### Basics
> Learn Doks basics, from content and layouts to assets, integrations, templates, and deployment, so you can build and ship sites confidently.
- [Project Structure](https://getdoks.org/docs/basics/project-structure/): Understand the Thulite project structure and where to place content, configuration, templates, assets, and static files for smooth workflows.
- [Pages](https://getdoks.org/docs/basics/pages/): Create and organize Thulite pages with regular files, leaf bundles, and branch bundles while controlling URL structure through content paths.
- [Markdown](https://getdoks.org/docs/basics/markdown/): Write Thulite content with Markdown syntax, frontmatter, code blocks, and media patterns that keep documentation readable and easy to maintain.
- [Shortcodes](https://getdoks.org/docs/basics/shortcodes/): Explore Doks shortcodes for adding structured, reusable content elements such as callouts, cards, tabs, previews, videos, and step-by-step guides.
- [Archetypes](https://getdoks.org/docs/basics/archetypes/): Define archetypes to standardize frontmatter for new content, reduce repetitive editing, and keep metadata consistent across sections in Thulite.
- [Layouts](https://getdoks.org/docs/basics/layouts/): Understand Thulite layout files, partial structure, and Hugo template lookup so you can customize how home, list, and single pages are rendered.
- [Partials](https://getdoks.org/docs/basics/partials/): Build reusable partial templates in Thulite layouts to share rendering logic, reduce duplication, and keep template code maintainable.
- [Menus](https://getdoks.org/docs/basics/menus/): Configure multilingual navigation menus in Thulite with menu files, weights, and page references for clear main, social, and footer navigation.
- [Styles](https://getdoks.org/docs/basics/styles/): Customize Thulite styling with SCSS variables and custom stylesheets, then rely on the build pipeline for compiled and optimized CSS output.
- [Scripts](https://getdoks.org/docs/basics/scripts/): Add custom JavaScript in Thulite using assets/js, DOM-ready patterns, and focused behaviors that improve interactivity without slowing pages.
- [Images](https://getdoks.org/docs/basics/images/): Organize and reference images in Thulite using practical paths, accessible alt text, and asset guidelines that keep pages clear and performant.
- [Fonts](https://getdoks.org/docs/basics/fonts/): Self-host fonts in Thulite with Fontsource, Hugo mounts, and SCSS variables to improve privacy, consistency, and performance across your site.
- [Deployment](https://getdoks.org/docs/basics/deployment/): Compare deployment options for Thulite and follow platform-specific guides to configure builds, publish public output, and launch reliably.
#### Shortcodes
> Explore Doks shortcodes for adding structured, reusable content elements such as callouts, cards, tabs, previews, videos, and step-by-step guides.
- [Shortcodes Overview](https://getdoks.org/docs/basics/shortcodes/shortcodes-overview/): Review the Doks shortcode collection and choose reusable content components for callouts, cards, tabbed sections, media, navigation, and guided steps.
- [Callout](https://getdoks.org/docs/basics/shortcodes/callout/): Use the Doks callout shortcode to highlight notes, tips, warnings, and important notices inline, helping readers quickly recognize essential guidance.
- [Card](https://getdoks.org/docs/basics/shortcodes/card/): Use the Doks card shortcode to present focused content with an optional icon, color, title, link, and body text in a consistent visual format.
- [Link Card](https://getdoks.org/docs/basics/shortcodes/link-card/): Use the Doks link card shortcode to create prominent, clickable links to related pages or external resources with clear titles and concise descriptions.
- [Card Grid](https://getdoks.org/docs/basics/shortcodes/card-grid/): Use the Doks card grid shortcode to arrange related cards in a responsive layout that keeps navigation choices and supporting content easy to scan.
- [Details](https://getdoks.org/docs/basics/shortcodes/details/): Use the Doks details shortcode to add accessible collapsible sections with a clear summary and hidden supporting content that readers can reveal when needed.
- [Preview](https://getdoks.org/docs/basics/shortcodes/preview/): Use the Doks preview shortcode to show a labeled live rendering beside its source, making it easier to explain shortcode behavior and expected output.
- [Steps](https://getdoks.org/docs/basics/shortcodes/steps/): Use the Doks steps shortcode to present ordered instructions with clear visual indicators, helping readers complete workflows one action at a time.
- [Tabs](https://getdoks.org/docs/basics/shortcodes/tabs/): Use the Doks tabs shortcode to group related content in an accessible tabbed interface, keeping alternative instructions and examples compact and organized.
- [Tree](https://getdoks.org/docs/basics/shortcodes/tree/): Use the Doks tree shortcode to render a clear file and folder structure from a Markdown list, with optional icons that improve visual scanning.
- [Video](https://getdoks.org/docs/basics/shortcodes/video/): Use the Doks video shortcode to embed self-hosted HTML video with a consistent presentation, giving readers helpful visual context without external embeds.
### Advanced
> Explore advanced Doks topics for performance, security, SEO, analytics, CMS integration, and multilingual sites to improve production readiness.
- [Code Blocks](https://getdoks.org/docs/advanced/code-blocks/): Create readable Doks code blocks with syntax highlighting, frames, titles, line numbers, and highlighted lines to explain commands and examples clearly.
- [Diagrams](https://getdoks.org/docs/advanced/diagrams/): Add Mermaid diagrams to Doks documentation using fenced code blocks to present flows, relationships, timelines, and processes directly alongside content.
- [Mathematics](https://getdoks.org/docs/advanced/mathematics/): Display mathematical expressions and equations in Doks with LaTeX and Markdown, including inline notation and larger formulas that remain clear for readers.
- [Internationalization](https://getdoks.org/docs/advanced/internationalization/): Set up multilingual Thulite sites using Hugo language config, translated content paths, and i18n string files for consistent localized experiences.
- [Versioning](https://getdoks.org/docs/advanced/versioning/): Publish multiple release-specific docs versions with Hugo's versioning system and set a default content version.
- [Performance](https://getdoks.org/docs/advanced/performance/): Improve Thulite build and runtime performance with focused guidance on caching strategy, payload reduction, and high-impact optimization steps.
- [Security](https://getdoks.org/docs/advanced/security/): Apply core security protections in Thulite with practical guidance for CSP, secure headers, and anti-scraping techniques for public websites.
- [SEO](https://getdoks.org/docs/advanced/seo/): Improve Thulite SEO with practical guidance for metadata, crawl signals, and visibility using the official SEO documentation and best practices.
- [Analytics](https://getdoks.org/docs/advanced/analytics/): Choose an analytics approach for Thulite with setup guides for Cabin, Fathom, Google Analytics, and Plausible implementations.
- [CMS](https://getdoks.org/docs/advanced/cms/): Choose a headless CMS for Thulite with quick-start guides for CloudCannon, Decap CMS, and Tina CMS to enable editor-friendly workflows.
### Reference
> Use this reference section to quickly find authoritative details on Thulite CLI, commands, configuration fields, and Markdown syntax behavior.
- [Reference Overview](https://getdoks.org/docs/reference/reference-overview/): Explore the Doks reference documentation for the CLI, configuration options, and Markdown syntax, with authoritative details for building and maintaining sites.
- [Configuration](https://getdoks.org/docs/reference/configuration/): Navigate Doks configuration references for file structure, core Hugo settings, parameters, and page frontmatter fields used in projects.
#### Configuration
> Navigate Doks configuration references for file structure, core Hugo settings, parameters, and page frontmatter fields used in projects.
- [Configuration Structure](https://getdoks.org/docs/reference/configuration/configuration-structure/): Understand the Thulite configuration layout, including default, environment-specific, and tooling files used to control build and site behavior.
- [Settings](https://getdoks.org/docs/reference/configuration/settings/): Reference core Hugo settings used by Thulite, including URLs, outputs, caching, taxonomies, minification, and related-content options.
- [Parameters](https://getdoks.org/docs/reference/configuration/parameters/): Reference key Thulite site parameters in params.toml, including metadata defaults and render hook behavior for links and images.
- [Page Frontmatter](https://getdoks.org/docs/reference/configuration/page-frontmatter/): Reference page frontmatter fields in Thulite content files, including metadata, draft state, ordering, and page-specific SEO options.
## Showcase
> Explore real-world websites built with Doks and discover how teams use its documentation tools, flexible components, and Hugo foundation across varied projects.
- [Geometry Dash Creator School](https://getdoks.org/showcase/geometry-dash-creator-school/): A free, community-run resource for learning to create Geometry Dash levels, with practical guides to building techniques, perspective, and animation.
- [Opsero Docs](https://getdoks.org/showcase/opsero-docs/): Official documentation for Opsero FPGA and FMC products, including datasheets, setup guides, and tools for developers and hardware designers.
- [socosci](https://getdoks.org/showcase/socosci/): socosci studies how people perceive, learn about, and understand one another across social contexts to support more connected lives and societies.
- [Fred](https://getdoks.org/showcase/fred/): Fred is a composable Python SDK for building agents that ingest knowledge, use tools, and deploy anywhere from prototypes to Kubernetes.
- [Sanah Bhimani](https://getdoks.org/showcase/sanah-bhimani/): Sanah Bhimani shares her work in experimental cosmology, writing, mentoring, and advocacy for women and female-presenting folks in STEM.
- [OpenCCA](https://getdoks.org/showcase/opencca/): OpenCCA is an open framework for early exploration and evaluation of Arm Confidential Compute Architecture research on non-CCA hardware.
- [PiRogue Tool Suite](https://getdoks.org/showcase/pirogue-tool-suite/): PiRogue Tool Suite is an open-source platform for network analysis, mobile forensics, and collaborative digital investigations.
- [Open Component Model](https://getdoks.org/showcase/open-component-model/): Open Component Model secures software delivery with signing, transport, and deployment across clouds, on-prem, and air-gapped environments.
- [Ahoi Attacks](https://getdoks.org/showcase/ahoi-attacks/): Ahoi Attacks is a research project exposing vulnerabilities in hardware-based trusted execution environments through malicious notifications.
- [Sunny Monday Labs](https://getdoks.org/showcase/sunny-monday-labs/): Sunny Monday Labs embeds engineers to build custom ERP systems, modules, and automation for scalable operations in Indonesia.
- [Orbis](https://getdoks.org/showcase/orbis/): Orbis is a Unity DOTS terrain renderer for spherical and flat worlds, with planetary level of detail and procedural generation.
- [Cybersecurity UW](https://getdoks.org/showcase/cybersecurity-uw/): Cybersecurity UW is a student-run club at UW-Madison offering collaborative learning through workshops, talks, research, and CTFs.
- [BigCode](https://getdoks.org/showcase/bigcode/): BigCode is an open scientific collaboration advancing responsible large language models for code through shared research, tools, and datasets.
- [Fablab Arnhem](https://getdoks.org/showcase/fablab-arnhem/): FabLab Arnhem makes digital fabrication accessible through makerspace access, workshops, and shared knowledge from a maker community.
- [Carsten Nichte](https://getdoks.org/showcase/carsten-nichte/): Carsten Nichte's portfolio explores photography, generative art, creative coding, writing, audio projects, and visual experimentation.
- [Matt Oswalt](https://getdoks.org/showcase/matt-oswalt/): Matt Oswalt's portfolio highlights software engineering, technical leadership, and clear communication through writing, speaking, and large-scale systems work.
- [GameSupport](https://getdoks.org/showcase/gamesupport/): GameSupport is a support desk for game studios, with customizable ticketing, dark mode, and fair pricing in early access.
- [Invidious](https://getdoks.org/showcase/invidious/): Invidious is an open-source, privacy-focused YouTube alternative that removes ads and tracking while offering subscriptions, playlists, and an API.
- [Aegisub](https://getdoks.org/showcase/aegisub/): Aegisub is a free, cross-platform subtitle editor for timing subtitles to audio, styling them, and previewing results with video.
- [Dive Coaching Australia](https://getdoks.org/showcase/dive-coaching-australia/): Dive Coaching Australia provides personalized coaching and guidance for divers seeking to improve their skills, confidence, and underwater performance.
- [Authelia](https://getdoks.org/showcase/authelia/): Authelia is an open-source authentication and authorization server providing single sign-on and multi-factor authentication for web applications.
- [Prometheus Operator](https://getdoks.org/showcase/prometheus-operator/): Prometheus Operator manages Prometheus clusters on Kubernetes using custom resources for deployment, configuration, and monitoring targets.
- [Samarth](https://getdoks.org/showcase/samarth/): Samarth eGov Suite documentation helps universities and higher-education institutions manage academics, governance, finance, and employee services.
- [Litestream](https://getdoks.org/showcase/litestream/): Litestream safely replicates SQLite databases to cloud storage for low-cost backups and point-in-time recovery.
- [Ctlos Linux](https://getdoks.org/showcase/ctlos-linux/): Ctlos Linux is a streamlined Arch-based distribution with graphical installers, multiple desktop environments, and ready-to-use configurations.
- [Fachschaft MPIC](https://getdoks.org/showcase/fachschaft-mpic/): Fachschaft MPIC represents TUM students in mathematics, physics, computer science, and chemistry with study resources, services, events, and support.
- [Loki Operator](https://getdoks.org/showcase/loki-operator/): Loki Operator manages secure, multi-tenant Grafana Loki instances on Kubernetes with declarative rules, authentication, and authorization.
- [Green Metrics Tool](https://getdoks.org/showcase/green-metrics-tool/): Green Metrics Tool measures application performance and resource use in containerized environments with reusable reporters, dashboards, and an API.
- [pntfx](https://getdoks.org/showcase/pntfx/): pntfx is an interactive mathematics learning platform connecting concepts through notes, videos, visual networks, and WeBWorK exercises.
- [Lotus](https://getdoks.org/showcase/lotus/): Lotus is Filecoin's Go-based reference implementation, providing tools to run nodes, store data, and operate as a storage provider.
- [Electric Blocks](https://getdoks.org/showcase/electric-blocks/): Electric Blocks is an open-source Minecraft mod for visually building and simulating accurate electrical grids with real-time multiplayer collaboration.
## Blog
> Read Doks release notes, product updates, and practical articles covering new features, improvements, and guidance for buil