Using Hugo, Go, and Templates for Lotus Documentation

At Lotus, we prioritize clear, fast, and maintainable documentation. To achieve this, we use Hugo, the powerful static-site generator written in Go, combined with Hugo’s flexible templates.

Why Hugo and Go?

Hugo provides speed, simplicity, and flexibility thanks to the power of Go. Since Go is a compiled language, Hugo builds your website at lightning speed, even if you have thousands of pages.

Benefits:

• Performance: Sites load extremely fast because they are fully static.
• Security: Less vulnerable to attacks since there is no active backend running.
• Ease of Use: Simple to install, configure, and maintain.
• Extensibility: Hugo Modules allow excellent reusability of components.

Using Hugo Templates

With Hugo’s powerful template engine, you can easily structure your documentation. Hugo uses the Go Templates templating language, which provides flexibility and clarity.

Basic Structure of Hugo Templates:

• layouts/ – Base structure and templates
• partials/ – Reusable template components
• shortcodes/ – Reusable content blocks within markdown
• content/ – Documentation content written in markdown

Setting Up Documentation for Lotus

Basic Workflow to Create Your Lotus Documentation:

Initialize Site:

hugo new site lotus-docs
cd lotus-docs

Add Modules:

hugo mod init lotus-docs
hugo mod get github.com/gohugoio/hugo-mod-bootstrap-scss/v5
hugo mod tidy

Create Content:

hugo new docs/getting-started.md

Publish:

hugo

Organizing Documentation for Lotus

For Lotus, we structure documentation neatly within folders inside the content/docs/ directory:

content/
├── docs/
│   ├── getting-started.md
│   ├── configuration.md
│   └── leads-genereren-vastgoed.md

This structure makes navigation and maintenance of documentation clear and manageable.

Getting Started

Use this approach to quickly create powerful, user-friendly, and scalable documentation for Lotus.

Happy documenting! 🚀