Welcome to the Just-the-docs documentation home page for the Map & Data Library at the University of Toronto Libraries. Here you will find the guide on how to edit our just-the-docs based sites
Structure of MDL just-the-docs sites
There are two main types of just-the-docs sites hosted by MDL via GitHub Pages:
- General guides sites: These are the main how-to-guides for various topics, such as GIS, data visualization, etc. It is meant to be browsed by patrons, and was hosted on MDL Drupal site previously.
- Special sites: These are just-the-docs sites that serve specific purposes, such as search portals, documentation for editing, etc.
Special sites:
| name | url | repository | description | when-to-edit | editing_guide_url |
|---|---|---|---|---|---|
| MDL just-the-docs editing guide | https://mdlutoronto.github.io/jtd-edit-setup/ | https://github.com/MDLutoronto/jtd-edit-setup | This site. Serve as the editing guide and documentation for all the MDL just-the-docs site. | When there's new guidance needed for editing just-the-docs site | https://mdlutoronto.github.io/jtd-edit-setup/ |
| MDL Gudies Search Page | https://mdlutoronto.github.io/tutorials-search/ | https://github.com/MDLutoronto/tutorials-search | The search catalouge for MDL guides. | When a new guide is created, existing guide metadata needs to be changed, or an old guide is to be deleted. | https://mdlutoronto.github.io/jtd-edit-setup/edit-tutorials-search |
| MDL just-the-docs template | / | https://github.com/MDLutoronto/jtd-template | A GitHub repository template. For creating a new just-the-docs site with MDL theme applied. | Almost never unless there's breaking changes for newer version for just-the-docs. | https://github.com/MDLutoronto/jtd-template/blob/main/README.md |
| MDL just-the-docs theme | / | https://github.com/MDLutoronto/jtd-theme | The remote theme to be applied to every repository created using the jtd-template. | When new UI components that apply to ALL just-the-docs MDL sites need to be updated. | https://github.com/MDLutoronto/jtd-theme/blob/main/README.md |