krustlet / krustlet-docs

Documentation for Krustlet

Krustlet Docs

📖 This repo contains the Krustlet Docs
🚢 Also the website config to generate docs.krustlet.dev
🔗 Looking for the main Krustlet.dev website? Visit krustlet.dev

Editing Content

docs.krustlet.dev is a static site. The documentation content needs to be located at docs/content/docs/.

To ensure the docs content renders correctly in the theme, each page will need to have front matter metadata. Example front matter:

---
title: "Docs Home"
linkTitle: "Home"
description: "Krustlet Docs"
weight: 1
type: docs
---

Front Matter Notes:

• inclusion of type: docs is important for the theme to properly index the site contents
• the linkTitle attribute allows you to simplify the name as it appears in the left-side nav bar - ideally it should be short and clear - whereas the title can handle longform names for pages/documents.

Site Development

Notes

• built with the Hugo static site generator
• custom theme uses Docsy as a base, with Bootstrap as the underlying css framework and some Krustlet custom sass additions
• deployed to Netlify via merges to main. (@flynnduism can grant additional access to account)
• metrics tracked via Google Analytics (as part of Krustlet.dev)

Install dependencies:

• Hugo installation guide
• NPM packages are installed by running yarn. Install Yarn if you need to.

Run the site:

// install npm packages
yarn

// rebuild the site (to compile latest css/js)
hugo

// or serve the site for local dev
hugo serve

Deploying the site:

The site auto deploys the main branch via Netlify. Once pull requests are merged the changes will appear at docs.krustlet.dev after a couple of minutes. Check the logs for details.

hugo serve will run the site locally at localhost:1313