Summary Files Commits Branches @commit @diff @stats
path: root / generate-hooks / README.md
blob: 3371de2782c5a1652a6e01204ff41085f0260707 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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 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.

On the "backend", they just get replaced with specific HTML. List of scripts that handle ftags:

|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`, `&&centered`, `&&/centered`, `&&fow`, `&&/fow`, `&&fcol`, `&&/fcol`, `&&fontSIZE` *(SIZE is one of `18`, `20`, `27`, `30`, `37`)*, `&&/font`|

Information regarding their usage can be found at the top of their respective script file.