Resources
The technologies listed below are those that enable the Writing with Visualizations project. The Learn-Static organization also hosts several modules that can help students and instructors better work through these technologies and concepts in a tutorial format. These modules are linked below:
- https://github.com/learn-static/foundations-0-github
- https://github.com/learn-static/foundations-1-html
- https://github.com/learn-static/foundations-2-markdown
- https://github.com/learn-static/foundations-3-data
- https://github.com/learn-static/foundations-4-computation
Documentation Template
To learn how to copy and customize your own version of this documentation template, see the Learn-Static Lesson Template README).
Technologies
Git & GitHub
GitHub is a popular web service for hosting Git repositories–with benefits! It provides a handy web interface for editing and collaborating on repos, as well as, built in project management features and free static web hosting powered by Jekyll. Accounts are free. To learn more check out Hello World on GitHub Guides or GitHub Learning Lab.
Markdown
Markdown is a standard to simplify writing content for the web. Markdown can be used any where on GitHub and in Jekyll.
Bootstrap 5
Bootstrap is a CSS framework designed to streamline developing user interfaces for your website.
Bootstrap Icons are SVG-based icon set used to add graphics to your content.
YAML
YAML is a human readable plain text data format. It is used in Jekyll for configuration, site data, and front matter. Jekyll projects are configured using the “_config.yml” file.
Liquid
Liquid is a flexible template language.
[In Jekyll]((https://jekyllrb.com/docs/liquid/) it allows you to layout pages built from modular components and data, using the “_includes”, “_layouts”, and “_data” directories.
Liquid includes features such as operators, loops, and filters to manipulate raw content.
Liquid statements are enclosed by {% %} and variables in {{ }}.
Sass
Sass is a CSS extension / preprocessor. All normal CSS is valid SCSS, but Sass adds many powerful functions and programmatic features. Writing SCSS is often easier and more sensible, for example by supporting nesting, variables, and operators. Jekyll lets you write SASS in modular chucks called partials, in the “_sass” directory, that will be combined and compiled into normal CSS files when the site is built.