This is a white label multi-tenant platform for us and our code school friends to use to manage our curricula. It's built on top of Hugo and Netlify CMS.
The platform, layout, styles and components are all developed in the Hugo module common-theme, mounted in hugo.toml
The shared content is developed in the Hugo module common-content, mounted in hugo.toml. This content is all headless blocks. It doesn't create any pages on your site unless you call it somewhere.
Multi-language support is provided by Hugo's i18n support.
Each org builds its own Hugo site that uses the common theme and content modules, and then makes any customisations they need and hosts and deploys it wherever they want.
- CodeYourFuture => https://curriculum.codeyourfuture.io/
- MigraCode => https://curriculum.migracode.org/
To customise the css, make a dir assets/custom-theme and throw any scss in there. It will be compiled and added last.
To add site logo/s, make a dir and add svgs to assets/custom-images/site-logo/. They will be added to the site header.
Add your content to content/ and customise the site config in config.toml. Please contribute any improvements you make back to the common theme and content modules.
Anything that is completely unique to your site should be added to this site module, not the common modules, so local /blocks and /layouts are fine.
For each module you import, add a replace directive to your go.mod file - if you forget to do this, you won't get live updates to your site when shared content changes. CI will remind you if you forget. If you don't need this feature, you can just pull updates manually with hugo mod get -u.
- Hugo - Static site generator
- Hugo Pipes - Asset pipeline
- Netlify - Hosting and deployment
- GitHub - Source code repository
- Bash - Bash script to create new module structures
brew install go hugoYou'll need to get a fine-grained GitHub API token which allows read-only access to all public CYF repos from this page.
Click "Generate new token", enter a token name (can be anything), and how long you want the token to last (if you're doing a one-off contribution, pick a short value; if you're going to be a regular contributor, maybe a longer value).
Make sure the Resource owner is your account if you have a choice.
The "Repository access" you need is "Public repositories (read-only)", and you don't need any account permissions:
Open to view screenshot of the required permissions
Copy the .env.example file over and name it .env. Edit the file and then change the line that says HUGO_CURRICULUM_GITHUB_BEARER_TOKEN to contain the token that you have generated earlier.
Run this command in a terminal, substituting in the github API token you generated above:
npm i
npm run start:devIf you find the build is very slow you can add development options to config/development.toml to speed it up. For example, you can set disableFastRender = true to disable fast render, or cache JSON files with maxAge = 12h. Don't do these things in production.
npm run start:dev./create_module <module-name>All CYF repos use the Prettier standard. However, Prettier doesn't have golang by default so you must install a plugin for it to work in VSCode. I've included it in the package.json.
PageFind runs the search. https://pagefind.app/
It's in the build command on Netlify hugo && npx pagefind --source "public"
If you need to develop on this locally, run:
rm -rf public &&
hugo && npx pagefind --site "public" --serveAnd go to http://localhost:1414/ to see the PageFind-served site with search enabled; but there is no hot reload. You can run hugo on http://localhost:1313/ at the same time.