Fork of geek doc
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.
 
 
 
 
renovate[bot] ed5c770d57
chore(deps): lock file maintenance (#431)
1 year ago
.chglog chore: adjust changelog template to link to prs instead of issues (#252) 2 years ago
.github [skip ci] fix github settings syntax 2 years ago
archetypes initial commit 3 years ago
assets/search refactor: unify title and description handling in meta files (#329) 1 year ago
exampleSite feat: add option geekdocDarkModeCode to enforce dark codeblocks (#429) 1 year ago
i18n feat: add propertylist shortcode (#414) 1 year ago
images chore: scale down the readme image to improve readability 2 years ago
layouts feat: add option geekdocDarkModeCode to enforce dark codeblocks (#429) 1 year ago
src feat: add option geekdocDarkModeCode to enforce dark codeblocks (#429) 1 year ago
.dictionary fix: remove table formatting from github gists (#416) 1 year ago
.drone.yml ci: switch to linkchecker (#410) 1 year ago
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.gitignore fix: fix edit page link and auto-detect contentDir (#343) 1 year ago
.jsbeautifyrc beautify html before uploading the documentation 3 years ago
.lighthouserc.yml ci: relax image-size-responsive in lighthouse runs (#328) 1 year ago
.linkcheckignore ci: switch to linkchecker (#410) 1 year ago
.markdownlint.yml fix: fix formatting on code links (#316) 1 year ago
.npmrc chore: limit supported nodejs versions (#323) 1 year ago
.prettierignore refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.prettierrc refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.tarignore chore: remove .vnuignore from release tarball (#264) 1 year ago
.vnuignore fix: replace invlaid max-height value 'auto' by 'none' (#419) 1 year ago
CONTRIBUTING.md docs: add contributing information 2 years ago
LICENSE chore: end of the year maintenance 1 year ago
README.md docs: fix theme build documentation (#318) 1 year ago
package-lock.json chore(deps): lock file maintenance (#431) 1 year ago
package.json fix(deps): update dependency katex to v0.16.0 (#432) 1 year ago
renovate.json chore: use renovate preset config 2 years ago
svgsprite.config.json feat: add optional hint/admonition icons (#383) 1 year ago
theme.toml add demosite config for hugoThemesSiteBuilder (#161) 2 years ago
webpack.config.js feat: add optional hint/admonition icons (#383) 1 year ago
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 1 year 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 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: