From 12876dd7905fe256fbd9a08315831916386ad4b6 Mon Sep 17 00:00:00 2001 From: sg Date: Thu, 5 Jun 2025 10:56:53 +0000 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7f0c1f..ec1f997 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,11 @@ Simplistic static site generator ## Quickstart ```git clone https://git.exocortex.ru/Exocortex/hydrogen.git``` ```cd hydrogen && pip install -r requirements``` -```./hydrogen.py``` \ No newline at end of file +```./hydrogen.py``` + +## Expectations +`hydrogen` expects the following files in the `content` folder: +- Markdown files ('*.md' only): these are the text files rendered to the HTML. +- Image files ('*.jpg' only): if a '.jpg' file is present with the same name as an '.md' file, the '.jpg' file will be rendered at the top of the HTML page and in the preview card for the entry. +- Custom CSS files ('.css' only): if a '.css' file is present with the same name as an '.md' file, it will be included in the HTML page. +- Custom Javascript files ('.js' only): if a '.js' file is present with the same name as an '.md' file, it will be included in the HTML page _for late loading_.