Cybrkyd's git repositories

GitGen • commit: 318c2ca

commit 318c2ca21b3a2e329c2d83998a84622552f522dfd6633ca3023a8f289164787d
author cybrkyd <noreply@cybrkyd.com> 2026-01-19 10:09:28 +0000
committer cybrkyd <noreply@cybrkyd.com> 2026-01-19 10:09:28 +0000

Commit Message

Directory Structure and README Rendering wording

📊 Diffstat

README.md 35
1 files changed, 35 insertions(+), 0 deletions(-)

Diff

diff --git a/README.md b/README.md
index 98cb151..0bb8ce8 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,41 @@ python3 gitgen.py
Open `git-website/index.html` in a browser or deploy the directory contents to a static web host.
+ ## Directory Structure
+
+ The generated output has the following structure:
+
+ ```
+ git-website/
+ ├── index.html
+ ├── main.css # main.css is not generated
+ ├── repo-name/
+ │ ├── index.html # README / overview
+ │ ├── files.html # File listing
+ │ ├── commits.html # Commit list
+ │ └── commits/
+ │ └── abc1234.html # Individual commit pages
+ ```
+
+ Each repository gets its own directory containing all related pages.
+
+ ## README Rendering
+
+ GitGen looks for README files in the following order:
+
+ * `README.md`
+ * `README.txt`
+ * `README`
+ * `readme.md`
+
+ Markdown READMEs are rendered using Python-Markdown with these extensions enabled:
+
+ * `tables`
+ * `sane_lists`
+ * `fenced_code`
+
+ Non-Markdown READMEs are rendered as escaped pre-formatted text.
+
## Licence
This project is made available under a GPL3 licence -- see COPYING for the full text.