From 3b0c7cc69686d5ab1d53207c30ef8f326d9751e4 Mon Sep 17 00:00:00 2001 From: Ricardo Lafuente Date: May 28 2024 09:49:55 +0000 Subject: Document steps to add a new website page --- diff --git a/website/README.md b/website/README.md index d985f73..a825db7 100644 --- a/website/README.md +++ b/website/README.md @@ -22,7 +22,20 @@ To make a local copy of the web site, follow these steps: ## Adding new pages -TODO +To create a new page and link to it, you just need to create a new text file with the `.md` (Markdown) extension inside the `website/content/pages` directory. For blog posts, place it in the `website/content/posts` directory. + +For pages, the only metadata required is the title. This should be placed in the first line of the file, with the syntax `Title: `. + +For blog posts, the `Date:` field is also required, using the syntax `Date: yyyy-mm-dd hh:mm`. Blog posts can also be grouped into series, which will display the other posts in the same series on the post page. For this, use the `Series:` metadata tag along with the `series_index` value to define the post position in the series list. Here's a complete example: + +``` +Title: JShelter can be translated into different languages +Date: 2023-09-08 14:00 +Series: i18n +series_index: 1 +``` + +To link to a page or blog post, use its slug (which is the same as its file name), e.g. `/pagename/`. ## Translating