From 09a9741fc797f174f3ce64ede8501f1668fa6641 Mon Sep 17 00:00:00 2001 From: pacien Date: Thu, 1 Dec 2022 03:01:28 +0100 Subject: move readme to index Since GitLab's web UI uses the index as the default page on the repo view. --- index.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'index.md') diff --git a/index.md b/index.md index 9bff6df..4f8a08a 100644 --- a/index.md +++ b/index.md @@ -2,12 +2,23 @@ title: "About" --- -# About this site +# Markdown course website example / template This is an example of course website, divided into two parts: lectures and exercises sheets. +Everything is generated from Markdown source files into static files which can +then be served through by any web server. -# Course plan +For convenience, the compilation and deployment can be automated through GitLab +CI or equivalent, which allows automatic publication of the latest version +after pushing the sources to a version-controlled repository for example. -* First lecture on the first day. + +## Resources and references + +- [Markdown syntax](https://daringfireball.net/projects/markdown/syntax) +- [Quarto (reference)](https://quarto.org/docs/reference/index.html) +- [Pandoc (manual)](https://pandoc.org/MANUAL.html) +- [Nix guides](https://nixos.org/learn.html) +- [GitLab CI configuration reference](https://docs.gitlab.com/ee/ci/yaml/) -- cgit v1.2.3