# Gaiden

Documentation tool that builds HTML pages from Markdown files, written in Groovy.


Source: https://findsoftware.frbit.cloud/gaiden/
Last reviewed: 2026-10-23
Listed since: 2026-10-23

## Record

### Links

- home: https://kobo.github.io/gaiden/
- repository: https://github.com/kobo/gaiden
- docs: https://kobo.github.io/gaiden/

### Identity

- status: active
- maintainer: The respective authors and developers
- maintainerType: community
- parent: unknown
- firstRelease: 2013
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: groovy
- runtime: jvm
- runtimeMin: unknown
- basedOn: unknown

### Content

- contentStore: flat-file
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: local, static
- renderingModes: static
- installMethod: SDKMAN (sdk install gaiden)

### License

- licenseModel: open-source
- license: Apache-2.0, Apache License, Version 2.0

### Releases

- currentMajor: 1
- latestReleaseDate: 2022-12-15

### Adoption

- githubStargazers: 172
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 6
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- urls: https://kobo.github.io/gaiden/ (read 2026-10-23)
- urls: https://api.github.com/repos/kobo/gaiden (read 2026-10-23)
- urls: https://github.com/kobo/gaiden/blob/main/README.md (read 2026-10-23)
- maintainer: https://github.com/kobo/gaiden/blob/main/NOTICE (read 2026-10-23)
- language: https://api.github.com/repos/kobo/gaiden (read 2026-10-23)
- category: https://github.com/kobo/gaiden/blob/main/README.md (read 2026-10-23)
- runtime: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- installMethod: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- installMethod: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- installMethod: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- contentStore: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- runsAs: https://kobo.github.io/gaiden/getting-started.html (read 2026-10-23)
- runsAs: https://kobo.github.io/gaiden/commands.html (read 2026-10-23)
- renderingModes: https://kobo.github.io/gaiden/commands.html (read 2026-10-23)
- license: https://api.github.com/repos/kobo/gaiden (read 2026-10-23)
- license: https://github.com/kobo/gaiden/blob/main/README.md (read 2026-10-23)
- licenseModel: https://github.com/kobo/gaiden/blob/main/README.md (read 2026-10-23)
- firstRelease: https://api.github.com/repos/kobo/gaiden/releases (read 2026-10-23)
- currentMajor: https://api.github.com/repos/kobo/gaiden/releases (read 2026-10-23)
- latestReleaseDate: https://api.github.com/repos/kobo/gaiden/releases (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/kobo/gaiden (read 2026-10-23)
- contributors: https://api.github.com/repos/kobo/gaiden/contributors (read 2026-10-23)

## Notes

Gaiden is a documentation tool that turns Markdown files into HTML pages, written in Groovy. A project holds the Markdown pages next to two Groovy configuration files, one for settings and one for the list of pages. The `build` command writes the HTML pages and static resources to a build directory, and `dist` zips the HTML files.

Gaiden runs on a Java SE installation, as the [getting started guide](https://kobo.github.io/gaiden/getting-started.html) states. The guide also describes a wrapper script that downloads Gaiden when a project's command first runs, so Gaiden need not be installed first.

## Worth knowing

The LICENSE file names no copyright holder; the NOTICE file names "the respective authors and developers".

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0