Quickstart

Basic syntax guide
Another basic syntax guide

Overview

This project generates HTML for https://www.marialoni.org

The most important directories and files are:

• content All content (web text and bibliographies) goes here
• resources All resources (pdfs) go here
• _include/contact.md contact information

After initial setup (see below) changes are done in three steps:

1. Make changes by editing content and/or adding resources.
   Content pages are written in Markdown, see the basic syntax guide for a quick overview. Note It is not mandatory to use Markdown, it is also fine to just write plain HTML. With some restrictions it is even possible to mix the two in one file.
2. Preview: run npm start to build assets and start Jekyll server, then go to http://localhost:4000/.
   It is not mandatory but recommended to do a preview before publishing because it is possible that a small unnoticed typo causes the site generation to fail after which your changes will not be published.
3. Publish is automated after pushing or merging to the default (main) branch
   This will take care that your changes are made public.

Local setup

This site

• is deployed using GitHub Pages
• uses Jekyll as web framework
• uses Jekyll-Scholar, a Jekyll extension for parsing BibTex files
• uses Vite for modern JavaScript asset bundling
• uses Bootstrap 5 and jQuery for UI components

For detailed JavaScript setup instructions, see JS_SETUP.md.

System wide setup, one time only, as user with administrator privileges.

• Install Homebrew
• Use Homebrew to install Git
• Use Homebrew to install Rbenv

For Linux the equivalent using apt, yum, emerge etc.

System setup, one time only, as regular user.

• Use Rbenv to install Ruby (version 2.6 or higher)
• Use Ruby to install Bundler

Project setup, as regular user.

• Use Git to clone https://github.com/marialoni/site
• Use Bundler to download project dependencies

If all went well you can now run jekyll serve and see the result on http://localhost:4000