HugoDocumentation

hugo-theme-plume — Hugo Documentation Template

By Dobefu

Plume is a lightweight Hugo-based documentation theme with no external resource dependencies, supporting responsive layout, automatic dark mode, code highlighting, search, and multilingual support.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews
Desktop homepage1 / 2
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-03View source

What stands out

A quick read of the recorded project description.

01

No external dependencies; no additional frontend build chain required after installation

02

Responsive layout with mobile navigation

03

Automatic dark mode and code syntax highlighting

04

Built-in table of contents (TOC), search, and internationalization (i18n) support

05

Supports web app manifest and SEO-related configuration

06

Can be integrated via Hugo Module or Git Submodule

Template Details

Plume is a Hugo theme for documentation sites, positioned as lightweight and free of external dependencies. It provides responsive layout, automatic dark mode, code syntax highlighting, mobile navigation, table of contents (TOC), search, internationalization (i18n), and a web app manifest, and can be used to build content-reading-focused documentation sites.

There are two installation methods: as a Hugo Module, or as a Git Submodule placed in the themes/plume directory. The theme is configured via hugo.toml, and the README provides example configurations for directory hierarchy, code highlighting, and Goldmark extensions (strikethrough, mark, insert, superscript/subscript, passthrough, etc.).

The theme uses the MIT license, allowing free use, modification, commercial use, and distribution; when distributing, the copyright notice and license notice must be retained. Third-party assets such as demo images, fonts, and icons must be checked separately under their respective licenses.

HugoDocumentation

Is it right for your project?

Use Cases

  • Building documentation sites for open-source projects
  • Writing product manuals or knowledge bases
  • Documentation sites requiring multilingual support and site search
  • Static sites where the theme should introduce no external dependencies and be easy to maintain long-term

Suitable For

  • Developers building static sites with Hugo
  • Teams needing a lightweight documentation theme without external dependencies
  • Projects requiring multilingual documentation and site search
  • Users who accept configuring theme behavior via hugo.toml

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    New site: hugo new site mysite, then enter the directory and run hugo mod init and hugo mod get github.com/Dobefu/hugo-theme-plume

  2. 2

    For an existing site, add it as a Hugo Module, or run git submodule add https://github.com/Dobefu/hugo-theme-plume.git themes/plume in the site root

  3. 3

    In hugo.toml, import the theme via module.imports under [module], or set theme = "plume"

  4. 4

    Configure markup.tableOfContents, markup.highlight, and markup.goldmark extensions according to the README examples

  5. 5

    The theme uses the MIT license; retain the copyright and license notice when distributing. Third-party assets such as demo images, fonts, and icons require separate license checks

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of this version and does not imply that external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of this version's code are permitted.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Demo images, fonts, icons, and other third-party assets must be checked under their respective licenses and cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur additional charges.
View Original Text Basis

Compiled by DeepSeek based on repository license and README ·2026-10-03. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
Hugo Themes
Documentation and maintenance reference score
More documented · 83 / 100
Technologies
Hugo
Website type
Documentation
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2025-12-02
Screenshot last checked
2026-10-03

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Hugo as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: [email protected] · 2026-10-04

Inspect the recorded source material

SHA-256: 653be928e19046ef48fdc7d4c469ae111555bd37398e54614629929e5a00e434

2026-10-03T13:44:16.135Z

Source file / repository
# Plume

A lightweight Hugo documentation theme without any external dependencies.

![Screenshot](https://github.com/Dobefu/hugo-theme-plume/blob/main/images/screenshot.png?raw=true)

## Features

- [x] Zero dependencies
- [x] Responsive design
- [x] Automatic dark mode
- [x] Syntax highlighting
- [x] Mobile navigation
- [x] Table of contents
- [x] SEO optimisation
- [x] Multi-language support (i18n)
- [x] Web app manifest
- [x] Search

## Installation (new site)

Create a new Hugo site with Plume:

```bash
hugo new site mysite
cd mysite
hugo mod init github.com/<username>/<site>
hugo mod tidy
hugo mod get github.com/Dobefu/hugo-theme-plume
```

Add to your `hugo.toml`:

```toml
[module]
  [[module.imports]]
    path = "github.com/Dobefu/hugo-theme-plume"
```

## Installation (existing site)

### As a Hugo Module

```bash
hugo mod init github.com/<username>/<site>
hugo mod tidy
hugo mod get github.com/Dobefu/hugo-theme-plume
```

Add to your `hugo.toml`:

```toml
[module]
  [[module.imports]]
    path = "github.com/Dobefu/hugo-theme-plume"
```

### As a Git Submodule

```bash
git submodule add https://github.com/Dobefu/hugo-theme-plume.git themes/plume
```

Add to your `hugo.toml`:

```toml
theme = "plume"
```

## Configuration

To configure the theme, update the `hugo.toml` file with the following:

```toml
[module]
  [[module.imports]]
    path = "github.com/Dobefu/hugo-theme-plume"

[markup]
  [markup.tableOfContents]
    startLevel = 2
    endLevel = 4

  [markup.highlight]
    lineNos = true
    noClasses = false

  [markup.goldmark]
    [markup.goldmark.extensions]
      strikethrough = false

      [markup.goldmark.extensions.extras]
        delete.enable = true
        mark.enable = true
        insert.enable = true
        subscript.enable = true
        superscript.enable = true

      [markup.goldmark.extensions.passthrough]
        enable = true

        [markup.goldmark.extensions.passthrough.delimiters]
          block = [['\[', '\]']]
          inline = [['\(', '\)']]

```

## License

MIT License - see [LICENSE](LICENSE) for details.
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.