Cybrkyd's git repositories

page-with-py • commit: 2c36fa7

commit 2c36fa7baa7402d26efee505b8cd943cd10bad496bae48fc13c04e8c392ef9e3
author cybrkyd <vii@cybrkyd.com> 2025-09-28 18:30:28 +0100
committer cybrkyd <vii@cybrkyd.com> 2025-09-28 18:30:28 +0100

Commit Message

README

📊 Diffstat

README.md 18
1 files changed, 15 insertions(+), 3 deletions(-)

Diff

diff --git a/README.md b/README.md
index 4336dd4..8adb8d8 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ Using Python3:
- Outputs tags from on-page hashtag trigger in markdown body `{{ hashtag:example }}`
- Front matter tags only are shown at the bottom of the content/blog post
- All tags (front matter and on-page hashtag trigger) have `/tags` pages generated and indexed.
+ - Tags support for mixed case hashtags
- Date formatting: Displayed dates can be formatted to preference in themes via Python's `strftime()` method.
### Content Organisation
@@ -46,12 +47,12 @@ Number of posts to display per page on index and archive pages.
**SITE_URL = "https://example.com"**
The complete base URL of the site, including protocol (https://).
- **SITE_DESC = "Site Description"**
- Default site description used in meta tags and when no page description is provided.
-
**SITE_TITLE = "My Site"**
Default site title used in page titles and when no page title is provided.
+ **SITE_DESC = "Site Description"**
+ Default site description used in meta tags and when no page description is provided.
+
**CONTENT_LANGUAGE = "en"**
The language code for the site's content (used in HTML lang attribute).
@@ -65,6 +66,17 @@ The theme to use from the `/themes/` directory. Must match exactly the name of a
The options are "numbers" or "direction".
This option controls the type of pagination style to output. "numbers" produces a URL chain of page numbers and "direction" is only a "next" & "previous" link.
+ **ENABLE_SEARCH = False**
+ The options are "True" or "False".
+ An optional search feature which uses lunr.js. Index is output to root folder as 'search-index.json' for integration.
+
+ **GENERATE_ARCHIVE = "yes"**
+ The options are "yes" or "no"
+ Generates an archive page based on the archive.html template.
+
+ **ARCHIVE_URL = "archive"**
+ The desired URL of the archive output. Someone might prefer '/blog' so here is the place to change it.
+
### Front Matter
**title:** the title which appears in `<title>` meta data and optionally at the top of pages.
**summary:** the data which appears in `<meta name="description"` and optionally as a summary of posts on index pages.