Skip to content
Snippets Groups Projects
Select Git revision
  • master default
  • patch-1
2 results
Blame Permalink
Forked from KWARC / kwarc.info / www
941 commits behind the upstream repository.
README.md 7.86 KiB

Repository holding the sources of the KWARC.info website

Note for authors: When editing some text, please do not hard wrap existing lines. This plays very bad with diffs, in particular an entire paragraph shows up as changed even though it might just be a single line. Furthermore, this introduces lots and lots of merge conflicts Markdown (similar to TeX) only inserts actual line breaks when making to link breaks in the source file. Thus the most readable and diff-compatible option is to write one sentence per line and use soft-wrapping on top in editors. This is called semantic linefeeds.

About

This website is built statically from Markdown source files using Jekyll. To update a page, just modify the corresponding source and push. This can be done online by clicking on Edit this page in the navigation menu. See the above links for details.

  • _config.yml: main configuration page
  • _includes/*: reusable chunks of web pages, like the nav bar
  • _layouts/*: local style files
  • _post/*.md: sources of the news, blog posts and activities
  • news/*: the KWARC news are generated here.
  • people/*.md: the KWARC home pages
  • projects/*.md: the KWARC project descriptions
  • public/*: all static files (images, js, css, etc)
  • public/*.md: descriptions of the research areas
  • systems/*.md: descriptions of the KWARC sytems
  • courses/*.md: KWARC courses (this may be obsoleted by univis)

Performance

This jekyll page is tuned in order to build as fast as possible. It also makes use of the jekyll-compress-html layout, to be efficiently transferable over network. During the evolution of the website, the build time has changed dramatically. It used to take around 5 minutes to build, with a few optimizations it now only takes up 15 seconds.

The biggest slowdowns were:

  • unneeded iterations
    • iterations within iterations (usually not required, if one thinks carefully)
    • if conditions within a loop, instead of a where clause
    • full iteration to extract a single item (use first instead)
  • repeated sorting of site.pages by the same menu_order key (instead sort this once and use a global variable)
  • multiple chained ifs instead of a single and
  • unneeded variable assignments (these seem to take a lot of time in liquid)

How to use Jekyll to test/build this website