docsy-example

An example documentation site using the Docsy Hugo theme

docker docsy docsy-example documentation-site documentation-website hugo hugo-theme hugo-theme-demo

Go to file

LisaFC f6f018df3d Update _index.html		2018-09-24 15:41:55 +01:00
assets/scss	Refactor: Split theme and example project	2018-09-04 11:36:40 +02:00
content	Update _index.html	2018-09-24 15:41:55 +01:00
resources/_gen	look at my shiny resources	2018-09-17 16:29:37 +01:00
themes	Put themes in themes	2018-09-04 12:00:51 +02:00
.gitignore	Refactor: Split theme and example project	2018-09-04 11:36:40 +02:00
.gitmodules	modified submodule	2018-09-17 15:37:40 +01:00
README.md	Update README	2018-09-04 14:04:08 +02:00
config.toml	Fix baseurl so this actually works	2018-09-17 16:52:47 +01:00
deploy.sh	Refactor: Split theme and example project	2018-09-04 11:36:40 +02:00
package-lock.json	Refactor: Split theme and example project	2018-09-04 11:36:40 +02:00
package.json	Refactor: Split theme and example project	2018-09-04 11:36:40 +02:00

README.md

In Example Project

The below will give you project that is set up and ready to use.

git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo-example.git
cd tech-doc-hugo-example
hugo server

Note that the theme is included as a Git submodule:

▶ git submodule
 a053131a4ebf6a59e4e8834a42368e248d98c01d themes/tech-doc-hugo-theme (heads/master)

If you want to do SCSS edits and want to publish these, you need to install PostCSS (not needed for hugo server):

npm install

In Theme Project

git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo-theme.git
cd tech-doc-hugo-theme/exampleSite
HUGO_THEMESDIR="../.." hugo server

Note that the Hugo Theme Site requires the exampleSite to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:

git subtree add --prefix exampleSite https://github.com/bep/tech-doc-hugo-example.git  master --squash

To pull in changes, see pull-deps.sh script in the theme.