From a74fd2c13fd273648f4e2e80ef326ae2a43a0316 Mon Sep 17 00:00:00 2001 From: Hans-Nikolai Viessmann Date: Fri, 15 Nov 2024 15:49:39 +0100 Subject: [PATCH] update jekyll config --- README.md | 22 ++++++++++++---------- _config.yml | 12 +++++------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d7e2861..3c416a5 100644 --- a/README.md +++ b/README.md @@ -11,26 +11,28 @@ Live pages are available at https://lsm-hpce.gitpages.psi.ch. The easiest and most reproducable way to test changes is using docker. From the top directory, run the following: -``` -docker-compose up +```console +$ docker compose build +$ docker compose up ``` -This will start a webserver on `http://0.0.0.0:4000/`. Changes to most pages +This will start a webserver on `http://0.0.0.0:4001/`. Changes to most pages will be automatically reflected in the website (with the exception of changes -to _config.yml, which requires restarting the webserver). +to `config.yml`, which requires restarting the webserver). ### Running locally + Building locally requires ruby 2.5 and bundler. To install: -``` -gem install bundler jekyll -bundle +```console +$ gem install bundler jekyll +$ bundle ``` To run a local webserver: -``` -bundle exec jekyll serve +```console +$ bundle exec jekyll serve ``` ## Theme @@ -62,4 +64,4 @@ by Tom Johnson. Theme content is licensed under the MIT license. The Navgoco jQuery component used in the sidebar is licensed under the BSD license. -See licenses subdirectory for license terms. \ No newline at end of file +See licenses subdirectory for license terms. diff --git a/_config.yml b/_config.yml index 300081a..2c2f854 100644 --- a/_config.yml +++ b/_config.yml @@ -19,10 +19,6 @@ github_editme_path: # gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ # if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. -disqus_shortname: -#disqus_shortname: idratherbewriting -# if you're using disqus for comments, add the shortname here. if not, leave this value blank. - google_analytics: #google_analytics: UA-66296557-1 # if you have google-analytics ID, put it in. if not, edit this value to blank. @@ -87,6 +83,7 @@ defaults: values: layout: "page" comments: true + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property search: true sidebar: home_sidebar topnav: topnav @@ -97,6 +94,7 @@ defaults: values: layout: "page" comments: true + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property search: true tooltip: true @@ -107,6 +105,7 @@ defaults: values: layout: "post" comments: true + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property search: true sidebar: home_sidebar topnav: topnav @@ -120,13 +119,12 @@ sidebars: - product2_sidebar - other -description: "Merlin 6 is the HPC cluster at Paul Scherrer Institute in Switzerland." +description: "Merlin is the HPC cluster at Paul Scherrer Institute in Switzerland." # the description is used in the feed.xml file # needed for sitemap.xml file only -# url: http://idratherbewriting.com -# baseurl: /documentation-theme-jekyll url: "https://lsm-hpce.gitpages.psi.ch" baseurl: / + github: [metadata]