From e7fdaa756dc2f616367199c339e5a63686cfa1f1 Mon Sep 17 00:00:00 2001 From: Marius Peter Date: Tue, 1 Mar 2022 21:53:40 +0100 Subject: README updated. --- README.org | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 86 insertions(+), 11 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index f4a00ca..9a7ca5c 100644 --- a/README.org +++ b/README.org @@ -1,32 +1,107 @@ +# -*- mode: org; -*- + #+TITLE: README #+SUBTITLE: README for this blog. #+AUTHOR: Marius Peter #+DATE: <2022-01-23 Sun> -#+OPTIONS: num:nil toc:nil +#+OPTIONS: num:nil toc:nil title:nil #+HTML_HEAD: -#+INCLUDE: resources/topnav.org -#+TOC: headlines 3 +# +INCLUDE: resources/topnav.org +# +TOC: headlines 1 -* TODOs +: ____ _________ ____ __ _________ ____ __ ____ +: / __ \/ ____/ | / __ \/ |/ / ____/ / __/___ _____ ____ ___ / /___ ____ / __/____ +: / /_/ / __/ / /| | / / / / /|_/ / __/ / /_/ __ \/ ___/ / __ `__ \/ / __ \/ __ \ / /_/ ___/ +: / _, _/ /___/ ___ |/ /_/ / / / / /___ / __/ /_/ / / / / / / / / / / / / /_/ / / __/ / +: /_/ |_/_____/_/ |_/_____/_/ /_/_____/ /_/ \____/_/ /_/ /_/ /_/_/_/ /_/ .___(_)_/ /_/ +: /_/ -** TODO Fix =make= process -Makefile should call =publish.el= which contains necessary org-publish -definitions. +#+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= -** =static/= +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. -*** =css/= -*** =images/= +** DONE Consolidate org publish component targets. +CLOSED: [2022-02-28 Mon] -** =README.org= +Too many components in ~org-publish-project-alist~. -- cgit v1.2.3