Home - harvardinformatics/informatics-website GitHub Wiki
Welcome to the informatics-website wiki!
This site is made using the Material for MkDocs theme as a base for the theme and structure, plus custom HTML, CSS, and Python scripts. This wiki serves to document how the site works and how it is updated.
General description
This is a description of the structure of the site directory and the contents of its sub-folders.
| Folder/file | Description |
|---|---|
data/ |
This contains various .json files that contain site data for the Resources and About (home) page. When the page is built, several .csv files are also placed here to be turned into Markdown tables. |
docs/ |
This folder contains the Markdown pages used by MkDocs to generate the site. The structure of files and folders in this directory should directly mirror that of the navigation of the website set-up in the main mkdocs.yml config file. There are some extra folders (e.g. assets/ and stylesheets/) that are not directly related to the structure of the site that will be explained later. |
scripts/ |
Python scripts that read data from the .json files in data/ and generate HTML that is inserted into Markdown templates for the Resources and About pages. This occurs automatically when the site is built via the hooks: setting in mkdocs.yaml. |
templates/ |
Markdown templates for the Resources, Resource tag tables, and About pages. |
mkdocs.yml |
This is the main configuration file for MkDocs and includes parameters relating to website navigation, style, and even some content. See comments within the file. |
Table of contents
Below are links to the sub-pages of this wiki that describe various parts of the site one may wish to edit.