Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 3.59 KB

README.md

File metadata and controls

83 lines (59 loc) · 3.59 KB

UVM Votes

Voting is a crucial feature of civic engagement, and making it accessible to everyone is our mission. This statically generated site is created with Eleventy, deployed over Netlify, and accessible by authorized editors through the CMS.

Getting Started / Install

Run the following to install dependencies and spin up a local server.

npm i && npm run serve

Informative Resources

Highcharts

Install

npm install highcharts-export-server -g

Run

highcharts-export-server -infile charts/voting.json -outfile assets/voting.svg -type svg

Netlify Content Management System

Eleventy Config

Pass eleventyConfig parameter to config function to access features.

Cleanup Date Format

Using NPM package for Eleventy plugin to clean up date.

Top Level Access for Sub-directory

Wanted some links to be given URL re-writes for the top level of my directory while still storing the files in an assets folder. Add the following to .eleventy.js:

eleventyConfig.addPassthroughCopy({ "assets/tld-links": "." })

Markdown

Markdown pre-processor can be changed from default liquid to other options.

Navigation

Used Eleventy filter to access next and previous collection items.

Search

Search is powered by Agolia and Netlify with plug and play authentication and features.

Calendar Button

The add to calendar button is powered by AddEvent. Pros and cons:

  • Pros: free, easy setup, provides multiple calendar options, & includes recurring events.
  • Cons: Clunky HTML first approach which creates FOUC; the API costs money, so this is a necessary evil.
    • This can be overcome by applying display: none to the class which the JS and CSS target.

Graphs

Graph is dynamically put together by Highcharts: API reference. Attempted an SVG export to lose bulky code, but SVG wasn't sufficiently responsive or engaging for my fancy.

Form Collection

The form is powered by Netlify at build time.

Lazy Load Images

Eleventy Plugin

Environement

Make sure NPM packages are globally accessible by appending source ~/.bash_profile to .zshrc, which can be found as a hidden file in the user's root directory. Source

Sitemap creation with collections

Walkthrough guide here

Dynamically Build Social Media Previews

https://mtm.dev/eleventy-social-sharing-images