Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.91 KB

1-overview.md

File metadata and controls

37 lines (27 loc) · 1.91 KB

Overview

Website Goals

  • Be Vala's offical presence on the internet
  • Advertise Vala in an attractive way
  • Encourage people to learn Vala
  • Increase the amount of traffic to Vala's source code repository
  • Provide an open space for the community to produce Vala content with creative freedom

Codebase Goals

  • Be as accessible as possible to contributors - Make it easy as possible for new people to contribute to the website.
  • Long-term maintainablitliy - Even after a long period of time, contributing to the website should still be a fast and seamless experience

Technical Details

  • The website is a static site and is generated using Zola
    • Extremely fast (written in Rust)
    • Is a single binary with no dependencies (Very simple to install)
  • Pages templates are powered by the Tera templating engine
  • Page content is written using the CommonMark implementation of markdown
    • Markdown files are human readable
    • Simple syntax
    • Well-documented
  • Sass is used for preprocessed styles:
    • Spliting styles across so that it's easier to make changes to specific places.
    • Taking advantage of preprocessing (calculations and variable substitutions during builds etc.)
    • Note: As of 2022-06-28, Zola uses libsass internally which doesn't support the latest Sass features
  • The rest of the site uses the standard trio of HTML, CSS and JavaScript

Using Different Technologies

The solution was picked for the website in order to achieve the codebase goals.

If you feel like there are better tools out there that can be used to achieve these goals, feel free to suggest them.