From daec47757cd94a91af51693dafb7ef2866fcd95f Mon Sep 17 00:00:00 2001 From: Nick Stokoe Date: Tue, 9 May 2023 21:08:20 +0100 Subject: [PATCH] src/README.md - brief intro for this folder --- src/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 src/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..f7cf178 --- /dev/null +++ b/src/README.md @@ -0,0 +1,16 @@ +# Source code + +This is the source code for WhenWe2. + +## Structre + +- `_articles/` - articles go here, in files with a .md suffix. The are essentially yaml files, with a leading `---`, then two sections, delimited with another `---`. The first section is the "front matter" - essentially a list of name/value pairs (or more generally, a datastructure - as in any YAML document items can be lists, directories, and so on, possibnly nested). The second section is markdown, which is essentially text, formatted according to certain conventions, and optionally containing HTML mark-up and template directives. See the Eleventy documentation for details of this. +- `assets/` - this is copied verbatim to the destination site. It contains stylesheets and javascript, for the most part. +- `_data/` - currently just contains a definition of the default layout to use on web pages. +- `_images/` - images used in the site, liked to via articles. Copied verbatim to the site, but as the directory `images/` +- `_includes/` - templates and template fragments, which define the layouts used to build the site HTML. +- `_pages/` - non-article web pages. +- `_people/` - descriptions of people. +- `index.html` - the site's front page template. + +