Fork of geek doc
 
 
 
 
Go to file
Alvaro Torres Cogollo a565da529f Allow description text in toc-tree items 2020-11-10 22:05:56 +01:00
.github setup prettier 2020-09-10 22:23:24 +02:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets/js initial commit 2020-01-12 15:33:02 +01:00
data split out css 2020-11-09 22:06:06 +01:00
exampleSite Allow description text in toc-tree items 2020-11-10 22:05:56 +01:00
images adjust spacing 2020-09-11 20:51:41 +02:00
layouts Allow description text in toc-tree items 2020-11-10 22:05:56 +01:00
src split out css 2020-11-09 22:06:06 +01:00
static split out css 2020-11-09 22:06:06 +01:00
.dictionary [skip ci] improve getting started documentation 2020-09-12 11:57:41 +02:00
.drone.yml split out css 2020-11-09 22:06:06 +01:00
.gitignore always try to upload lhci reports 2020-07-17 10:34:52 +02:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml temp switch to warn instead of error for the performance category 2020-09-19 15:48:14 +02: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 lighthouse-ci to drone 2020-06-02 18:11:29 +02:00
CHANGELOG.md split out css 2020-11-09 22:06:06 +01:00
LICENSE [SKIP CI] update readme 2020-01-14 23:00:23 +01:00
README.md migrate to thegeeklab namespace 2020-09-27 22:21:29 +02:00
gulpfile.js split out css 2020-11-09 22:06:06 +01:00
package-lock.json [skip ci] improve getting started documentation 2020-09-12 11:57:41 +02:00
package.json cleanup npm scripts 2020-10-20 16:38:47 +02:00
theme.toml migrate to thegeeklab namespace 2020-09-27 22:21:29 +02: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 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 master 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
gulp default

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

Contributors

Special thanks goes to all contributors.

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.