github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-21 20:30:39 +00:00
Code Issues Projects Releases Wiki Activity
309 Commits 6 Branches 167 Tags 30 MiB
HTML 43.4%
SCSS 40.6%
JavaScript 15.6%
CSS 0.4%
fb5e1f2ef1
Go to file
Robert Kaussow fb5e1f2ef1
chore: scale down the readme image to improve readability
2021-04-28 09:31:23 +02:00
.chglog ci: auto-generate changelog 2021-02-11 21:25:43 +01:00
.github update branch protection 2021-04-11 15:23:11 +02:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets Dark mode (#66) 2021-04-27 23:44:35 +02:00
data hash css/js assets by default 2020-11-22 19:06:04 +01:00
exampleSite Dark mode (#66) 2021-04-27 23:44:35 +02:00
images chore: scale down the readme image to improve readability 2021-04-28 09:31:23 +02:00
layouts Dark mode (#66) 2021-04-27 23:44:35 +02:00
src Dark mode (#66) 2021-04-27 23:44:35 +02:00
static hash css/js assets by default 2020-11-22 19:06:04 +01:00
.dictionary docs: add known limitations (#94) 2021-04-11 13:58:06 +02:00
.drone.yml Dark mode (#66) 2021-04-27 23:44:35 +02:00
.gitignore Dark mode (#66) 2021-04-27 23:44:35 +02:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml chore: set a proper value for lighthouse throttling (#59) 2021-02-07 14:13:39 +01:00
.markdownlint.yml add unsorted list style 2020-06-03 16:47:10 +02:00
.prettierignore setup prettier 2020-09-10 22:23:24 +02:00
.prettierrc setup prettier 2020-09-10 22:23:24 +02:00
.tarignore add documentation for different menu type 2020-12-21 14:23:21 +01:00
CONTRIBUTING.md docs: add contributing information 2021-01-03 22:10:01 +01:00
gulpfile.js Dark mode (#66) 2021-04-27 23:44:35 +02:00
LICENSE update to hugo v0.80 in ci 2021-01-03 22:13:59 +01:00
package-lock.json Dark mode (#66) 2021-04-27 23:44:35 +02:00
package.json chore(deps): pin dependencies (#100) 2021-04-28 00:51:06 +02:00
README.md Dark mode (#66) 2021-04-27 23:44:35 +02:00
renovate.json chore: use renovate preset config 2021-01-03 22:11:14 +01:00
theme.toml chore: replace master by main as default branch 2021-04-11 15:11:59 +02:00

README.md

Geekdoc

Build Status Hugo Version GitHub release GitHub contributors License: MIT

Important: We have switched to 'main' as default branch. The 'master' branch is no longer maintained and will be removed after April 30, 2021!

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 got 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 gulp and bundled in a release tarball. You can download the latest release from the GitHub release page.

Due to the fact that gulp is used as pre-processor 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 gulp locally and run the default pipeline once to create all required assets.

# install required packages from package.json
npm install

# run gulp pipeline to build required assets
npx gulp default

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: