You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Robert Kaussow 6a694e72b8
add documentation for multilingual mode
1 day ago
.chglog chore: adjust changelog template to link to prs instead of issues (#252) 1 month ago
.github [skip ci] fix github settings syntax 8 months ago
archetypes initial commit 2 years ago
assets/search rework search integration (#262) 2 weeks ago
exampleSite add documentation for multilingual mode 1 day ago
i18n add documentation for multilingual mode 1 day ago
images chore: scale down the readme image to improve readability 9 months ago
layouts add documentation for multilingual mode 1 day ago
src add lang handling for the search 3 days ago
.dictionary add documentation for multilingual mode 1 day ago
.drone.yml chore: cleanup build setup and webpack requirements (#265) 2 weeks ago
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago
.gitignore add documentation for multilingual mode 1 day ago
.jsbeautifyrc beautify html before uploading the documentation 2 years ago
.lighthouserc.yml refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago
.markdownlint.yml add unsorted list style 2 years ago
.npmrc refactor: cleanup and restructure gulp tasks (#101) 9 months ago
.prettierignore refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago
.prettierrc refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago
.tarignore chore: remove .vnuignore from release tarball (#264) 2 weeks ago
.vnuignore feat: add katex math typesetting shortcode (#157) 7 months ago
CONTRIBUTING.md docs: add contributing information 1 year ago
LICENSE chore: end of the year maintenance 4 weeks ago
README.md docs: fixed typos and minor textual improvements (#259) 2 weeks ago
package-lock.json chore(deps): update dependency eslint to v8.7.0 3 days ago
package.json add documentation for multilingual mode 1 day ago
renovate.json chore: use renovate preset config 1 year ago
svgsprite.config.json refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago
theme.toml add demosite config for hugoThemesSiteBuilder (#161) 7 months ago
webpack.config.js fix: fix asset loading on subfolder deployments (#287) 3 days ago
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 2 weeks ago

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 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: