Summary Files Commits Branches @commit @diff @stats
path: root / generate-hooks / README.md
diff options
context:
space:
mode:
Commit1fe3d39788cfb0a167ff562fa121c90ea3b445c7 (patch)
Author
 Syndamia <kamen@syndamia.com>
2022-07-04 16:41:27 +0300
Committer
 Syndamia <kamen@syndamia.com>
2022-07-04 16:41:27 +0300
Files548480d4dbd98da7e1d06f1d9c339a871600af21 /generate-hooks/README.md
syndamia.com-1fe3d39788cfb0a167ff562fa121c90ea3b445c7.tar
syndamia.com-1fe3d39788cfb0a167ff562fa121c90ea3b445c7.tar.gz
syndamia.com-1fe3d39788cfb0a167ff562fa121c90ea3b445c7.zip
Parent287748bcd9d17462219699d01bb0d043812a9a8e (diff)
Reworked how HTML-editing scripts are handled
1 files changed, 14 insertions, 0 deletions
-rw-r--r--generate-hooks/README.md14
diff --git a/generate-hooks/README.md b/generate-hooks/README.md
new file mode 100644
index 0000000..d3c9210
--- /dev/null
+++ b/generate-hooks/README.md
@@ -0,0 +1,14 @@
+These scripts are ran by `generate.sh` and `generate-dev.sh` (which just run all .sh files in this folder). They're meant to modify the "compiled" HTML files.
+
+## ftags
+
+ftags are strings/words in the Markdown source files, that start with "&&" and continue with any (valid) sequence of characters. The name initially stood for "file tags", since the `make-file-lists.sh` script was the first to utilize them, but I've expanded their usage and their current name means "format tags".
+
+Their purpose is to shorten and abstract certain custom HTML code that I want to use in my pages (but will have to include as-is in the Markdown files). List of scripts that handle ftags:
+
+|Script|ftags|ftag can be anywhere in text|
+|---|---|---|
+|`make-file-lists.sh`|`&&fos`, `&&fs0`, `&&fs`, `&&fod`|No|
+|`make-flags.sh`|`&&gb`|Yes|
+
+For more information on how to use the different ftags, consult the specified script.