Annotation-Pushers
/
Annotation-System
1
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Matt Mascarenhas 2022-09-23 17:47:12 +01:00
parent 0825cbb5ff
commit 6ea5cb6d22
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -67,11 +67,11 @@ and [Hardening your HTTP response headers](https://scotthelme.co.uk/hardening-yo
General purpose tag that outputs the URL of the specified asset General purpose tag that outputs the URL of the specified asset
relative to the Images Directory (-i) relative to the Images Directory (-i)
- `<!-- __CINERA_CSS__ path.ext -->` - `<!-- __CINERA_CSS__ path.ext -->`
Convenience tag that outputs a <link rel="stylesheet"...> node Convenience tag that outputs a `<link rel="stylesheet"...>` node
for the specified asset relative to the CSS Directory (-c), for for the specified asset relative to the CSS Directory (-c), for
use inside your <head> block use inside your `<head>` block
- `<!-- __CINERA_JS__ path.ext -->` - `<!-- __CINERA_JS__ path.ext -->`
Convenience tag that outputs a <script type="text/javascript"...> Convenience tag that outputs a `<script type="text/javascript"...>`
node for the specified asset relative to the JS Directory (-j), node for the specified asset relative to the JS Directory (-j),
for use wherever a `<script>` node is valid for use wherever a `<script>` node is valid
The path.ext in these tags supports parent directories to locate the The path.ext in these tags supports parent directories to locate the
@ -80,9 +80,9 @@ or JS), including the "../" directory, and paths containing spaces must
be surrounded with double-quotes (\-escapable if the quoted path itself be surrounded with double-quotes (\-escapable if the quoted path itself
contains double-quotes). contains double-quotes).
All these asset tags additionally perform revving, appending a query All these asset tags additionally perform versioning, appending a query string
string (-Q) and the file's checksum to the URL. Changes to a file (-Q) and the file's checksum to the URL. Changes to a file trigger a rehash and
trigger a rehash and edit of all HTML pages citing this asset. edit of all HTML pages citing this asset.
- Navigation / Menu tags: - Navigation / Menu tags:
- `<!-- __CINERA_NAV__ -->` - `<!-- __CINERA_NAV__ -->`
@ -90,6 +90,7 @@ trigger a rehash and edit of all HTML pages citing this asset.
subprojects of both the aforementioned subprojects of both the aforementioned
- `<!-- __CINERA_GLOBAL_NAV__ -->` - `<!-- __CINERA_GLOBAL_NAV__ -->`
This menu will contain every project in the configuration This menu will contain every project in the configuration
These navigation tags additionally take one parameter, e.g. These navigation tags additionally take one parameter, e.g.
`<!-- __CINERA_NAV__ horizontal -->`: `<!-- __CINERA_NAV__ horizontal -->`:
- `dropdown` - `dropdown`