Exocortex/hydrogen
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
sg
2025-06-05 10:56:53 +00:00
parent c9b74399ec
commit 12876dd790
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -5,4 +5,11 @@ Simplistic static site generator
## Quickstart ## Quickstart
```git clone https://git.exocortex.ru/Exocortex/hydrogen.git``` ```git clone https://git.exocortex.ru/Exocortex/hydrogen.git```
```cd hydrogen && pip install -r requirements``` ```cd hydrogen && pip install -r requirements```
```./hydrogen.py``` ```./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_.