diff options
[hooks] Updated and reformatted documentation for everything in hooks, including README
1 files changed, 9 insertions, 9 deletions
| -rw-r--r-- | generate-hooks/README.md | 18 |
diff --git a/generate-hooks/README.md b/generate-hooks/README.md index 52bb4f4..5949be4 100644 --- a/generate-hooks/README.md +++ b/generate-hooks/README.md @@ -1,15 +1,15 @@ -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. +All `.awk` files in this folder are ran by `generate.sh` and `generate-dev.sh`, after ssg and lowdown have created all HTML pages. These files are meant to work on the resultant HTML. ## 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". +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 I got the idea while making the file lists functionality. Now I like to think of them as "format tags", since they are used for so much more. -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: +On the "backend", they just get replaced with specific HTML. List of scripts that handle ftags: -|Script|ftags|ftag can be anywhere in text| -|---|---|---| -|`make-file-lists.awk`|`&&fos`, `&&fs0`, `&&fs`, `&&fod`|No| -|`make-flags.awk`|`&&gb`|Yes| -|`make-presentation.awk`|`&&slide`, `&&/slide`, `&&flexer`, `&¢ered`, `&&/centered`, `&&fow`, `&&/fow`, `&&fol`, `&&/fol`, `&&font18`, `&&font20`, `&&font27`, `&&font30`, `&&font35`, `&&/font`|No| +|Script|ftags| +|---|---| +|`make-file-lists.awk`|`&&folder`, `&&file`, `&&/files`, `&&ft-TYPE` *(TYPE is one of `photo`, `text`, `zip`, `movie`, `markdown`)*| +|`make-flags.awk`|`&&gb`| +|`make-presentation.awk`|`&&presentation`, `&&slide`, `&&/slide`, `&&flexer`, `&¢ered`, `&&/centered`, `&&fow`, `&&/fow`, `&&fol`, `&&/fol`, `&&fontSIZE` *(SIZE is one of `18`, `20`, `27`, `30`, `37`)*, `&&/font`| -For more information on how to use the different ftags, consult the specified script. +Information regarding their usage can be found at the top of their respective script file. |