mouchar / gooddata-docs-theme

GoodData Documentation Theme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gdc-docs-theme

GoodData Documentation Theme extends and overrides Docsy theme for Hugo static site generator. It provides ont only GoodData-branded styling but also some additional functionality, like support for custom versioning scheme, translated documentation and Redocly API refernces.

Usage

In order to use this theme in an existing repository you should include contents of this repository as a git submodule alongside with the Docsy theme.

Git submodule definition:

[submodule "docs/themes/gdcDocsTheme"]
	path = docs/themes/gdcDocsTheme
	url = https://github.com/gooddata/gdc-docs-theme.git
	branch = basic-theme

Hugo configuration file (config.toml):

theme = ["GDCDocsTheme", "docsy"]

License

(C) 2007-2023 GoodData Corporation

For more information, please see LICENSE.

About

GoodData Documentation Theme

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:HTML 47.3%Language:SCSS 42.6%Language:JavaScript 7.2%Language:CSS 2.9%