TyDiForm web site

The TyDiForm web site uses Jekyll for generation of web pages from Markdown source, and YAMT theme as lipstick. The pages are served via GitHub pages at https://tydiform.fmf.uni-lj.si.

How to edit the web page content

The pages are written in the Markdown format and automatically translated to HTML by GitHub. Simply edit the Markdown files and use Git to push the changes back to the server. The website always shows the contents of the master branch of the GitHub repository.

1. git pull
2. Make changes to .md files (see below)
3. git status to see what files you changed
4. git add XYZ.md for every file you changed and you wish to commit
5. git push
6. Go to the project web page, make sure to reload the page.

The .md files are Markdown files, here is a quick Markdown reference.

Page source files:

• index.md -- main project page
• members.md -- project members
• activities.md -- a timeline of project activities
• resources.md -- software and formalization libraries
• publications.md -- project-related publications

How to generate the web page locally

You need not generate the pages before you publish them, but it might be a good idea to do so and verify that the pages are OK, especially if you make significant changes.

To generate web pages locally for preview, you need Jekyll, which needs a million subsidiary Ruby packages. Rather than trying to install them with your bare hands, you should just try

bundle install

With a bit of luck you've got Ruby installed so this command will do the right thing. The bundle command is part of the Ruby Bundler package manager. On a Mac it is available through Homebrew. On Linux it is available through your package manager, e.g. on Debian/Ubuntu `sudo apt install ruby-bundler ruby-dev'.

Then to generate and serve the pages locally, run

bundle exec jekyll serve

The pages will appear at http://127.0.0.1:4000/.