systemausfall.org/hugo-theme-hilfe
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
449 commits 1 branch 0 tags 17 MiB
HTML 46.7%
SCSS 36%
JavaScript 12.5%
CSS 4.8%
Go to file
Robert Kaussow 5c5e2d59cb
refactor: replace gulp by webpack and npm scripts (#258) 
BREAKING CHANGE: We have replaced `gulp` with `webpack` and `npm scripts` to build this theme. If you build it on your own or use build commands during the deployment, you may have to adjust your setup.

BREAKING CHANGE: The `GeekblogIcons` font is using the icon name as Unicode now. As a consequence, you have to replace all references to Icons from this font if you have customized the theme.

BREAKING CHANGE: We have refactored the search integration to split Hugo templates from JavaScript code. To get it working again, you need to adjust the `outputFormats` and `outputs` in your Hugo configuration file, as [documented](https://geekdocs.de/usage/configuration/#site-configuration).
2022-01-06 13:58:10 +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] 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 refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
exampleSite refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
images chore: scale down the readme image to improve readability 2021-04-28 09:31:23 +02:00
layouts refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
src refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.dictionary chore: normalize default favicons and add docs (#213) 2021-09-27 22:47:13 +02:00
.drone.yml refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.gitignore refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +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 add unsorted list style 2020-06-03 16:47:10 +02: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 refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +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
package-lock.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
package.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
README.md docs: fixed typos and minor textual improvements (#259) 2022-01-05 09:44:06 +01: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 refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +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 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: