summaryrefslogtreecommitdiff
path: root/README.org
blob: 9a7ca5ce62d3659f6ff5eded0a4797223fd561c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# -*- mode: org; -*-

#+TITLE: README
#+SUBTITLE: README for this blog.
#+AUTHOR: Marius Peter
#+DATE: <2022-01-23 Sun>
#+OPTIONS: num:nil toc:nil title:nil

#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="resources/mlnp.css" />
# +INCLUDE: resources/topnav.org
# +TOC: headlines 1


:      ____  _________    ____  __  _________   ____                        __              ____    
:     / __ \/ ____/   |  / __ \/  |/  / ____/  / __/___  _____   ____ ___  / /___  ____    / __/____
:    / /_/ / __/ / /| | / / / / /|_/ / __/    / /_/ __ \/ ___/  / __ `__ \/ / __ \/ __ \  / /_/ ___/
:   / _, _/ /___/ ___ |/ /_/ / /  / / /___   / __/ /_/ / /     / / / / / / / / / / /_/ / / __/ /    
:  /_/ |_/_____/_/  |_/_____/_/  /_/_____/  /_/  \____/_/     /_/ /_/ /_/_/_/ /_/ .___(_)_/ /_/     
:                                                                              /_/                  


#+begin_abstract
A [[https://en.wikipedia.org/wiki/README][README]] file describes a project folder's structure. This enables
visitors to understand the logic behind the folder's structure; to
find resources as efficiently as possible; also, present the project
objectives, as well as related projects.
#+end_abstract


* Website structure

 The website's structure is described in the following sections.

 
** =index.org=

This is the homepage. It is displayed by default when a user accesses
the mlnp.fr website.


** =resources/=

This folder contains static resources that are copied verbatim during
the website publishing process.


*** =resources/css.org=

This file contains the entire website's styling information. During
publication, this file's sections are tangled to a single stylesheet
=resources/mlnp.css=. This reduces website load times, as only a
single HTTP request is required to obtain styling rules for the entire
website. Albeit negligible, this optimization is [[https://stackoverflow.com/questions/2336302/single-huge-css-file-vs-multiple-smaller-specific-css-files][recommended]] across
the web.


*** TODO =images/=

This is where website images live.


** =wiki/=

This folder contains all the wiki pages. They are published at
[[http:wiki.mlnp.fr]].


** =blog/=

This folder contains all blog posts. They are all published at
[[http:blog.mlnp.fr]].


** =README=

The README file documents the website's structure, as well as pending
TODO items.


* TODOs


** DONE Ensure anchor link isn't hidden by topnav
CLOSED: [2022-02-28 Mon]

When a user clicks a link in the table of contents, the linked heading
is hidden behind the topnav bar. It should instead appear lower than
the topnav, to ``reassure'' the user that they have jumped to the
proper section.


** DONE CSS transitions
CLOSED: [2022-02-28 Mon]

Implement CSS transitions for menu.


** DONE Pure CSS hamburger menu
CLOSED: [2022-02-28 Mon]

Replace HTML trigram with pure CSS spans.


** DONE Consolidate org publish component targets.
CLOSED: [2022-02-28 Mon]

Too many components in ~org-publish-project-alist~.
Copyright 2019--2026 Marius PETER