Fork of geek doc
 
 
 
 
Go to file
Renovate Bot 78a24426c5 chore(deps): update dependency svg-sprite to v1.5.4 2022-02-03 16:40:53 +00: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] fix github settings syntax 2021-05-25 17:56:53 +02:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets/search rework search integration (#262) 2022-01-06 22:52:22 +01:00
exampleSite docs: fix theme build documentation (#318) 2022-02-03 14:41:42 +01:00
i18n feat: add multilingual mode support (#241) 2022-01-23 13:21:44 +01:00
images chore: scale down the readme image to improve readability 2021-04-28 09:31:23 +02:00
layouts fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
src fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
.dictionary docs: fix theme build documentation (#318) 2022-02-03 14:41:42 +01:00
.drone.yml chore: cleanup build setup and webpack requirements (#265) 2022-01-07 16:18:07 +01:00
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.gitignore feat: add multilingual mode support (#241) 2022-01-23 13:21:44 +01:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.markdownlint.yml fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
.npmrc refactor: cleanup and restructure gulp tasks (#101) 2021-05-05 22:44:36 +02: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 feat: add katex math typesetting shortcode (#157) 2021-07-01 09:05:26 +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
README.md docs: fix theme build documentation (#318) 2022-02-03 14:41:42 +01:00
package-lock.json chore(deps): update dependency svg-sprite to v1.5.4 2022-02-03 16:40:53 +00:00
package.json chore(deps): update dependency svg-sprite to v1.5.4 2022-02-03 16:40:53 +00:00
renovate.json chore: use renovate preset config 2021-01-03 22:11:14 +01:00
svgsprite.config.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
theme.toml add demosite config for hugoThemesSiteBuilder (#161) 2021-07-06 21:41:38 +02:00
webpack.config.js fix: fix asset loading on subfolder deployments (#287) 2022-01-16 16:03:31 +01:00
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00

README.md

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

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

Contributors

Special thanks goes 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: