Skip to content

About the site

Host

The Phoenix Projects operate as a study group of the Twin Cities Section of the Institute of Electrical and Electronics Engineers ⧉.

The Phoenix Biorhythm site is hosted on GitHub Pages.

Static Site Generator

MkDocs is a static site generator that's geared towards building project documentation. Documentation source files are written primarily in Markdown ⧉, and configured with a single YAML configuration file

This site uses Markdown, HTML and cascading style sheets.

For full documentation, visit mkdocs.org ⧉.

MkDocs Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml              # The configuration file
docs/
    index.md            # The documentation homepage
    about/
        index.md
        images/         # subproject-specific images
        ...
    abpm/               # ambulatory blood pressure monitor subproject
        index.md
        images/         # subproject-specific images
       ...
    algorithms/         # biorhythm analysis algorithms subproject
        index.md
        images/         # subproject-specific images
        ...
    biorhythm-platform/ # biorhythm analysis platform subproject
        index.md
        images/         # subproject-specific images
        architecture/
            index.md
            ...
        privacy-security/
            index.md
            ...
        requirements/
            index.md
            ...
    library/
        index.md
        ...
    glossary/
        index.md
        images/         # glossary-specific images
    images/             # program-general images, icons and clip art     
    javascripts/
    snippets/
    stylesheets/
    ...                 # Other markdown pages and other files

Theme

Material for MkDocs ⧉

Macros

See macros info

Typography

Material for MkDocs directly integrates with Google Fonts ⧉. All fonts are taken from that collection.

Body text and titles are set in cabin, a nonserif font.

Code samples are set in Ubuntu Mono, a nonserif, monospace font.

For clients who do not have these fonts, the style sheets specify some standard alternatives.

See also "Privacy".

Palette

The site provides both light and dark color schemes:

Mode Color Scheme
Light MkDocs default
Dark MkDocs slate

The primary color is set to blue-grey (#546d78).

The accent color is set to indigo (#4051b5).

Graphics

Image         Explanation Source
Phoenix Mark The Phoenix Projects mark symbolizes the investigation of variation in blood pressure. The Phoenix is a composite of the following three images.
Human Heart Cutaway The interior of a human heart and some of the blood vessels SERVIER MEDICAL ART, a service to medicine provided by Les Laboratoires Servier www.servier.com ⧉. Image retrieved from https://smart.servier.com/wp-content/uploads/2016/10/coeur_01.png ⧉.

Servier Medical Art is licensed under CC BY 4.0  ⧉
Magnifying Glass Magnifying glass "Magnifying Glass", by deelight ⧉, on OPENCLIPART.org ⧉.

Public Domain
Pulse Curve BP-ECG Timing An abstract:
  1. electrocardiogram (ECG) tracing in lime green (#33cc33)
  2. An abstract atrial blood pressure cycle in persian red (#cc3333)
The tracings are drawn along the same timescale.		 Derived from the image titled "Timing of arterial pulse and the ECG", in "Normal arterial line waveforms", Deranged Physiology: A free online resource for Intensive Care Medicine ⧉, by Alex Yartsev ⧉.

The derivation removed all but the waveforms and converted the result to SVG.
The Phoenix Logo incorporates the Phoenix Mark. Phoenix Logo
favicon The favicon is "circadian rhythms" by bsd studio from Noun Project ⧉ (CC BY 3.0).

The hero image on the site's home page is the Phoenix Projects mark with CCS animation added to the waveforms.

Math Notation

Math statements are rendered with the LaTex ⧉ typesetting language, using the MathJax ⧉ library for displaying mathematical content in browsers. MathJax is incorporated into MkDocs using arithmatex ⧉, a Python Markdown extension.

Blog

The site uses the blog plug-in built into Material for MkDocs ⧉.

A blog entry is written in Markdown, with meta data in the files header.

---
date:
  created: 2024-04-24
  updated: 2024-10-15
categories:
  - Meeting Minutes
---

With the meta data, the plug-in automatically creates archive and category pages that list a subset of posts for a time interval or category.

Warning

Before the blog may become fully active, the project must still resolve details about attribution to, and mediation of, authors.

Privacy

The site uses the privacy plugin built into Material for MkDocs ⧉. The plugin:

  1. Scans the generated HTML for external assets, such as scripts, style sheets, images, and web fonts.
  2. Downloads them.
  3. Stores them in the site directory.
  4. Replaces all references with links to the downloaded copies for self-hosting.

License

Tip

The following site, provided by GitHub, is recommended for picking an open source license.

https://choosealicense.com ⧉.

This work is licensed under Creative Commons Attribution 4.0 International Public License ⧉.

This license is intended for documentation and media only. It is not intended for any software or hardware described on this site.