Skip to content

SPANDigital/presidium

Repository files navigation

Presidium

This repository tracks Presidium's user documentation and provides a sample of how presidium is used.

What is Presidium?

Presidium is a software documentation management system for agile teams and their users made from the stuff software engineers love. Presidium uses familiar tools already in use by many software development teams to easily compose and publish and manage quality documentation.

Read Presidium's documentation for details on all features and for help on setting up a new project using the sample template.

How do I use Presidium?

For detailed instructions on getting started, please see Getting Started.

Features and Issues

All upcoming features and issues are tracked here.

Development

Presidium embeds a specific version of Hugo to ensure that the user is building their docs with a Hugo version that is compatible with our Presidium Themes.

Since we require the embedded Hugo version to be built into a binary, some of the cli commands only work after running the make build cmd.

Getting started

Initialize the theme submodules before building or running tests:

git submodule update --init --recursive

Run the build command:

make build

Move the binary into a valid documentation site directory, then run the hugo build cmd:

./presidium hugo 

Or if you want to serve the site after the hugo build, then run:

./presidium hugo server