SAGE Docusarus Tayloring

Authors	Kai Berszin
Last Updated	10/12/2025, 12:48:54 PM
Last Author	Kai Berszin

Scope

This page describes the custom docusarus component / plugin utilized by this docusarus instance.

Index Table

The index table adds a custom sage field for the front matter of a markdown file.
The index table is generated before the content of the markdown file and includes metadata for the page such as authors, responsibles and date of last update.
Additionally it is possible to add a Admonition to mark confidential content e.g. under external NDA.

---
    sage:
        indexTable: boolean
        confidential: boolean
        authors: string | list[string] | null
        responsible: string | list[string] 
---

Field	Default	Description
indexTable	false	Toggle the generation of the index table; does not concern confidentiality admonition.
confidential	false	Toggle the generation of the confidentiality admotion.
todo	false	Toggle the generation of the todo admotion.
authors	undefined	Specifiy the authors of the given page. If left undefined or given an empty list, this field will be hidden from the index table.
responsible	undefined	Specify the responsibles of the given page. If left undefined will default to Not specified. If set to null will be hidden from the index table.

The confidentially admotion will be displayed as following:

danger

This document contains confidential data and is not intended to be shared outside of SAGE!

The todo admotion will be displayed as following:

warning

🚧 This document is still being actively worked on and is subject to change. 🚧

The Last Updated and Last Author field are taken from docusaurus and are generated from the last git update of any given page.