README

Author: Marius Peter
Date: <2022-01-23 Sun>

Table of Contents

Website structure
TODOs

# -*- mode: org; -*-

#+SUBTITLE: README for this blog. #+OPTIONS: num:nil toc:nil title:nil

#+HTML_HEAD: <link rel"stylesheet" type"text/css" href"resources/global.css"/> #+HTML_HEAD: <link rel"icon" type"image/png" href"resources/favicon.png"/> #+INCLUDE: resources/topnav.html export html # +TOC: headlines 1

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

#+begin_abstract A 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

#+TOC: headlines 2

Website structure

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

#+NAME: tree

  echo '(Only drilling down 2 levels.)'
  tree -L 2

#+RESULTS: tree

(Only drilling down 2 levels.)
.
├── README.html
├── README.org
├── about.org
├── blog
│   ├── 2022
│   ├── 2023
│   ├── index.org
│   └── sitemap.org
├── cv.org
├── index.html
├── index.org
├── publish-mlnp.org
├── resources
│   ├── css.org
│   ├── favicon.png
│   ├── favicon.xcf
│   ├── fonts
│   ├── global.css
│   └── topnav.html
├── sitemap.org
└── wiki
    ├── aerospace
    ├── emacs
    ├── images
    ├── index.org
    ├── languages
    ├── linux
    ├── programming
    ├── sitemap.org
    └── typography

13 directories, 17 files

=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/global.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 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.

CLOSED: [2022-02-28 Mon]

Replace HTML trigram with pure CSS spans.