How to set up a home section
TL;DR
You want to have a card for a Lepiter page automatically installed in the Home Section of GT when you load your GitHub repo (i.e., a card similar to the Glamorous Toolkit Book
card).
Steps
Use the GtHomeStartPageSection
class.
By default, this will generate a home section with a card containing the first TOC card of the default database.
GtHomeStartPageSection new
You can configure the section title, card title, description, the lepiter database to use, and the name of the start page.
GtHomeStartPageSection new sectionTitle: 'Get started with the YAML Parser project'; title: 'YAML Parser'; description: 'The YAML Parser project'; databaseName: 'YAML Parser Notebook'; startPageName: 'YAML Parser Overview'
To install this as a home section card, you must implement an extension method of the GtHome
class.
GtHome >> yamlSection
<gtHomeSection>
^ GtHomeStartPageSection new
title: 'YAML Parser';
description: 'The YAML Parser project';
databaseName: 'YAML Parser Notebook';
startPageName: 'YAML Parser Overview';
priority: 8
Note that this should be categorized as an extension method of one of your packages, for example *YAMLParser
(assuming YAMLParser
is a package of your repo). In this way, as soon as your repo is loaded, so will the extension method, and your card will automatically appear in the home section.