Maia's Contradance Site

Made with Jekyll, using a modified Slimpress theme.

Running, Developing, Deploying

Setup

• get access to Ruby (currently using 3.0.0)—presumably via RVM or similar
• bundle install

Preview

To preview site: bundle exec jekyll serve. (This automatically refreshes to reflect the majority of changes, but NOT changes to the config file or Ruby plugins.)

Deploy

This site is deployed via Cloudbuild. To release, just push changes to master (no need to jekyll build etc.).

Dance Formatting

Dances loaded into my choreo page and represented in blog posts have the following fields:

• title: str
• author || coauthor: str
• formation: str
• difficulty: str (one of accessible | advanced | expert)
• fave: bool
• comp_notes: str
• choreo_notes: str
• date_written: str (yyyymm)
• blurb: str
• video_link: str
• choreo: dict[section: str --> moves: list[str]]
  • e.g.:

  a1:
    - long lines forward and back
    - long lines forward and back
  a2:
    - long lines forward and back
    - long lines forward and back
  etc.

• footnotes: dict[ref: int --> content: str]
  • footnotes origins in the above sections are denoted with text[^1]. As long as the text is passed through the footnoter Jekyll filter, the reference will be properly rendered, and linked to the footnote with ref=1.

Tooltips for Dance Choreo

To create a tooltip'd dance link (using Tippy):

• make sure that your post/page has a dances object in the frontmatter: should be a list of dance objects (as spec'd above)
• include your dance as an element in that dances list
• create the link with {% include custom/dance_tooltip_link.html dance_title='Dance Title Here' %}. May be used multiple times to reference the same dance.
• if your frontmatter has a dances list, Jekyll will automatically include _includes/custom/dance_tooltip_script.js, which imports Tippy and registers dance choreo to the corresponding tooltip

TODO

• [] choreo: mark new dances?
• [] choreo: describe difficulty levels
• [] choreo: filter by difficulty level, favorite, etc.?
• [] choreo: mousing over a footnote highlights the corresponding text
• [] blog: sidebar with recent posts? (look at formatting in partials/sidebar.scss, which currently isn't imported)
• [] dance tooltips: hovering over dance link changes the tooltip icon to hover color as well
• [] javascript etc.: only load JS scripts (fitfids, fancybox) when requested by the page