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

Merge branch 'main' of https://git.exocortex.ru/Exocortex/hydrogen

Browse Source
This commit is contained in:
SG
2025-06-05 18:14:45 +03:00
parent 12c9f5f296 c42cfb1597
commit 046ec8a9ee
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -5,7 +5,7 @@ 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.txt`
_put some Markdown files into the `content` directory._ _put some Markdown files into the `content` directory._
@@ -35,8 +35,8 @@ _the `public` directory is ready to be published._
The resulting HTML files are rendered from the Markdown source files in the `content` folder, so even the plain text source files will work. The resulting HTML files are rendered from the Markdown source files in the `content` folder, so even the plain text source files will work.
The correct HTML may be included directly in the source file and will be rendered both in the preview card and in the HTML page. The correct HTML may be included directly in the source file and will be rendered both in the preview card and in the HTML page.
`frontmatter` header is recommended, specifying the following values: `frontmatter` header is recommended, specifying the following values:
- `title`: "Will be rendered in the preview card and in the HTM page" (String) - `title`: "Will be rendered in the preview card and in the HTML page" (String)
- `omit_second_title`: "Should the title be displayed immediately above the text in the HTML page (HTML page always also displays the title in the header) (Boolean, "True|False") - `omit_second_title`: Should the title be displayed immediately above the text in the HTML page (HTML page always also displays the title in the header) (Boolean, "True|False")
- `date`: Timestamp, like the date and time the text was created. ("2000-01-01T00:00:00+03:00") - `date`: Timestamp, like the date and time the text was created. ("2000-01-01T00:00:00+03:00")
## Configuration ## Configuration
@@ -46,7 +46,7 @@ Configuration is minimal and done via the self-explanatory `config.py` file.
Individual HTML pages can be customized via CSS and Javascript. To do so, put a '.css' and/or '.js' file into the `content` directory and make sure those files have the same name as the source '.md file'. E.g.: Individual HTML pages can be customized via CSS and Javascript. To do so, put a '.css' and/or '.js' file into the `content` directory and make sure those files have the same name as the source '.md file'. E.g.:
- `article-01.md` - source file rendered to HTML. - `article-01.md` - source file rendered to HTML.
- `article-01.css` - a CSS file with custom styles for the resulting HTML page. - `article-01.css` - a CSS file with custom styles for the resulting HTML page.
- `article-01.js` - a Javasscript file with custom logic for the resulting HTML page. - `article-01.js` - a Javascript file with custom logic for the resulting HTML page.
## Directories and structure ## Directories and structure
### Output directories ### Output directories