No description
Find a file
2022-11-10 10:02:45 +01:00
.chglog chore: adjust changelog template to link to prs instead of issues (#252) 2021-12-12 13:14:33 +01:00
.github [skip ci] adjust repo config 2022-07-21 09:56:18 +02:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets/search refactor: unify title and description handling in meta files (#329) 2022-02-07 10:57:43 +01:00
exampleSite feat: add option to enable or disable the dark mode toggle button (#529) 2022-11-02 15:48:45 +01:00
i18n fix: fix typo in ja translation file (#508) 2022-09-28 09:01:48 +02:00
images chore: scale down the readme image to improve readability 2021-04-28 09:31:23 +02:00
layouts feat: add option to enable or disable the dark mode toggle button (#529) 2022-11-02 15:48:45 +01:00
src feat: add option to enable or disable the dark mode toggle button (#529) 2022-11-02 15:48:45 +01:00
.dictionary fix: remove table formatting from github gists (#416) 2022-05-24 00:37:06 +02:00
.drone.yml chore: bump hugo to v0.105.0 (#532) 2022-11-05 08:12:38 +01:00
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.gitignore ci: improve version file and tarball creation (#486) 2022-08-29 22:53:07 +02:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml ci: relax image-size-responsive in lighthouse runs (#328) 2022-02-07 09:27:28 +01:00
.markdownlint.yml fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
.npmrc chore: limit supported nodejs versions (#323) 2022-02-04 13:53:49 +01:00
.prettierignore refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.prettierrc refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.tarignore chore: remove .vnuignore from release tarball (#264) 2022-01-06 23:27:25 +01:00
.vnuignore fix: replace invlaid max-height value 'auto' by 'none' (#419) 2022-05-23 22:37:12 +02:00
CONTRIBUTING.md docs: add contributing information 2021-01-03 22:10:01 +01:00
LICENSE chore: end of the year maintenance 2021-12-21 10:37:09 +01:00
package-lock.json chore(deps): lock file maintenance (#534) 2022-11-10 10:02:45 +01:00
package.json fix(deps): update dependency mermaid to v9.2.2 (#535) 2022-11-10 09:51:19 +01:00
README.md ci: improve version file and tarball creation (#486) 2022-08-29 22:53:07 +02:00
renovate.json chore: use renovate preset config 2021-01-03 22:11:14 +01:00
svgsprite.config.json feat: add optional hint/admonition icons (#383) 2022-04-23 15:14:42 +02:00
theme.toml feat: support mermaid codeblocks (#485) 2022-08-29 21:52:44 +02:00
webpack.config.js feat: add option to enable or disable the dark mode toggle button (#529) 2022-11-02 15:48:45 +01:00
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00

Geekdoc

Build Status Hugo Version GitHub release GitHub contributors License: MIT

Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of good alternatives out there. You can find a demo and the full documentation at https://geekdocs.de.

Desktop and mobile preview

Build and release process

This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by webpack and bundled in a release tarball. You can download the latest release from the GitHub release page.

Due to the fact that webpack and npm scripts are used as pre-processors, the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install webpack locally and run the build script once to create all required assets.

# install required packages from package.json
npm install

# run the build script to build required assets
npm run build

# build release tarball
npm run pack

See the Getting Started Guide for details about the different setup options.

Contributors

Special thanks to all contributors. If you would like to contribute, please see the instructions.

Geekdoc is inspired and partially based on the hugo-book theme, thanks Alex Shpak for your work.

License

This project is licensed under the MIT License - see the LICENSE file for details.

The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack: