summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpacien2022-12-01 03:01:28 +0100
committerpacien2022-12-01 03:01:28 +0100
commit09a9741fc797f174f3ce64ede8501f1668fa6641 (patch)
treea4978738bc6bee312f76db67c975c6f4d6495aa5
parent1721d747bb225e19f97acf88c68af62661d33af8 (diff)
downloadmarkdown-course-website-09a9741fc797f174f3ce64ede8501f1668fa6641.tar.gz
move readme to index
Since GitLab's web UI uses the index as the default page on the repo view.
-rw-r--r--index.md17
-rw-r--r--readme.md20
2 files changed, 14 insertions, 23 deletions
diff --git a/index.md b/index.md
index 9bff6df..4f8a08a 100644
--- a/index.md
+++ b/index.md
@@ -2,12 +2,23 @@
2title: "About" 2title: "About"
3--- 3---
4 4
5# About this site 5# Markdown course website example / template
6 6
7This is an example of course website, divided into two parts: lectures and 7This is an example of course website, divided into two parts: lectures and
8exercises sheets. 8exercises sheets.
9 9
10Everything is generated from Markdown source files into static files which can
11then be served through by any web server.
10 12
11# Course plan 13For convenience, the compilation and deployment can be automated through GitLab
14CI or equivalent, which allows automatic publication of the latest version
15after pushing the sources to a version-controlled repository for example.
12 16
13* First lecture on the first day. 17
18## Resources and references
19
20- [Markdown syntax](https://daringfireball.net/projects/markdown/syntax)
21- [Quarto (reference)](https://quarto.org/docs/reference/index.html)
22- [Pandoc (manual)](https://pandoc.org/MANUAL.html)
23- [Nix guides](https://nixos.org/learn.html)
24- [GitLab CI configuration reference](https://docs.gitlab.com/ee/ci/yaml/)
diff --git a/readme.md b/readme.md
deleted file mode 100644
index 1645cf6..0000000
--- a/readme.md
+++ /dev/null
@@ -1,20 +0,0 @@
1# Markdown course website example / template
2
3This is an example of course website, divided into two parts: lectures and
4exercises sheets.
5
6Everything is generated from Markdown source files into static files which can
7then be served through by any web server.
8
9For convenience, the compilation and deployment can be automated through GitLab
10CI or equivalent, which allows automatic publication of the latest version
11after pushing the sources to a version-controlled repository for example.
12
13
14## Resources and references
15
16- [Markdown syntax](https://daringfireball.net/projects/markdown/syntax)
17- [Quarto (reference)](https://quarto.org/docs/reference/index.html)
18- [Pandoc (manual)](https://pandoc.org/MANUAL.html)
19- [Nix guides](https://nixos.org/learn.html)
20- [GitLab CI configuration reference](https://docs.gitlab.com/ee/ci/yaml/)