README updated.

Commit
e7fdaa756dc2f616367199c339e5a63686cfa1f1
Author
Marius Peter <marius.peter@tutanota.com>
Author date
Committer
Marius Peter <marius.peter@tutanota.com>
Committer date
README.org
index f4a00ca4..9a7ca5ce 100644..100644
@@ -1,32 +1,107 @@
1 Added: # -*- mode: org; -*-
2 Added:
1 3 #+TITLE: README
2 4 #+SUBTITLE: README for this blog.
3 5 #+AUTHOR: Marius Peter
4 6 #+DATE: <2022-01-23 Sun>
5 Removed: #+OPTIONS: num:nil toc:nil
7 Added: #+OPTIONS: num:nil toc:nil title:nil
6 8
7 9 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="resources/mlnp.css" />
8 Removed: #+INCLUDE: resources/topnav.org
9 Removed: #+TOC: headlines 3
10 Added: # +INCLUDE: resources/topnav.org
11 Added: # +TOC: headlines 1
10 12
11 13
12 Removed: * TODOs
14 Added: : ____ _________ ____ __ _________ ____ __ ____
15 Added: : / __ \/ ____/ | / __ \/ |/ / ____/ / __/___ _____ ____ ___ / /___ ____ / __/____
16 Added: : / /_/ / __/ / /| | / / / / /|_/ / __/ / /_/ __ \/ ___/ / __ `__ \/ / __ \/ __ \ / /_/ ___/
17 Added: : / _, _/ /___/ ___ |/ /_/ / / / / /___ / __/ /_/ / / / / / / / / / / / / /_/ / / __/ /
18 Added: : /_/ |_/_____/_/ |_/_____/_/ /_/_____/ /_/ \____/_/ /_/ /_/ /_/_/_/ /_/ .___(_)_/ /_/
19 Added: : /_/
13 20
14 Removed: ** TODO Fix =make= process
15 21
16 Removed: Makefile should call =publish.el= which contains necessary org-publish
17 Removed: definitions.
22 Added: #+begin_abstract
23 Added: A [[https://en.wikipedia.org/wiki/README][README]] file describes a project folder's structure. This enables
24 Added: visitors to understand the logic behind the folder's structure; to
25 Added: find resources as efficiently as possible; also, present the project
26 Added: objectives, as well as related projects.
27 Added: #+end_abstract
18 28
19 29
20 30 * Website structure
21 31
22 32 The website's structure is described in the following sections.
23 33
34 Added:
24 35 ** =index.org=
25 36
26 Removed: ** =static/=
37 Added: This is the homepage. It is displayed by default when a user accesses
38 Added: the mlnp.fr website.
27 39
28 Removed: *** =css/=
29 40
30 Removed: *** =images/=
41 Added: ** =resources/=
31 42
32 Removed: ** =README.org=
43 Added: This folder contains static resources that are copied verbatim during
44 Added: the website publishing process.
45 Added:
46 Added:
47 Added: *** =resources/css.org=
48 Added:
49 Added: This file contains the entire website's styling information. During
50 Added: publication, this file's sections are tangled to a single stylesheet
51 Added: =resources/mlnp.css=. This reduces website load times, as only a
52 Added: single HTTP request is required to obtain styling rules for the entire
53 Added: website. Albeit negligible, this optimization is [[https://stackoverflow.com/questions/2336302/single-huge-css-file-vs-multiple-smaller-specific-css-files][recommended]] across
54 Added: the web.
55 Added:
56 Added:
57 Added: *** TODO =images/=
58 Added:
59 Added: This is where website images live.
60 Added:
61 Added:
62 Added: ** =wiki/=
63 Added:
64 Added: This folder contains all the wiki pages. They are published at
65 Added: [[http:wiki.mlnp.fr]].
66 Added:
67 Added:
68 Added: ** =blog/=
69 Added:
70 Added: This folder contains all blog posts. They are all published at
71 Added: [[http:blog.mlnp.fr]].
72 Added:
73 Added:
74 Added: ** =README=
75 Added:
76 Added: The README file documents the website's structure, as well as pending
77 Added: TODO items.
78 Added:
79 Added:
80 Added: * TODOs
81 Added:
82 Added:
83 Added: ** DONE Ensure anchor link isn't hidden by topnav
84 Added: CLOSED: [2022-02-28 Mon]
85 Added:
86 Added: When a user clicks a link in the table of contents, the linked heading
87 Added: is hidden behind the topnav bar. It should instead appear lower than
88 Added: the topnav, to ``reassure'' the user that they have jumped to the
89 Added: proper section.
90 Added:
91 Added:
92 Added: ** DONE CSS transitions
93 Added: CLOSED: [2022-02-28 Mon]
94 Added:
95 Added: Implement CSS transitions for menu.
96 Added:
97 Added:
98 Added: ** DONE Pure CSS hamburger menu
99 Added: CLOSED: [2022-02-28 Mon]
100 Added:
101 Added: Replace HTML trigram with pure CSS spans.
102 Added:
103 Added:
104 Added: ** DONE Consolidate org publish component targets.
105 Added: CLOSED: [2022-02-28 Mon]
106 Added:
107 Added: Too many components in ~org-publish-project-alist~.