numfocus / DISCOVER-Cookbook

The NumFOCUS DISCOVER Cookbook (Diverse & Inclusive Spaces and Conferences: Overall Vision and Essential Resources). A guide for organizing more diverse and inclusive events and conferences, produced by the NumFOCUS Diversity & Inclusion in Scientific Computing (DISC) Program, with support from the Moore Foundation.
http://discover-cookbook.numfocus.org
MIT License
175 stars 23 forks source link

remove/migrate Jekyll styler metadata from page headers #50

Closed noatamir closed 1 year ago

noatamir commented 1 year ago

Most of the pages have Jekyll style metadata like this at the top of each page:

---
layout: page
title: Childcare
---

# Childcare

**Tags:** <span style="color:red">Parents and Carers</span>, <span style="color:red">Participant Diversity</span>, <span style="color:red">Scholarships</span>

✅ Offer financial support for childcare.
 - Build it into your budget. 
   - Link it to sponsorships, or university partners, ...

Jbook uses different metadata, need to research more, but it's built on top of Sphinx, so is similar. May not need them at all because jbook automatically creates table of contents and sections from markdown headers like # Childcare automatically.

mikofski commented 1 year ago

copied from temporary transition repo "discover-handbook" https://github.com/numfocus/DISCOVER-handbook/issues/6

mikofski commented 1 year ago

according to jupyter book documentation, references to sections and docs can be adding a label role like this:

(About=)
# About

then reference the "About" section anywhere in the cookbook as either {ref}About\ or as [](About). In fact since this is a document it could also be referenced using the {doc} directive or markdown as [](./About.md), see: Reference Content Files.