From 5e99d49dee4a26b4952e224d4e2b4ce1129479f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Sun, 25 Oct 2020 10:24:44 +0100 Subject: [PATCH] Fixed README documentation. --- README | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README b/README index d13802f..2f7c495 100644 --- a/README +++ b/README @@ -31,8 +31,8 @@ generated site directories, looking for includes of templates and parsing variables. ## Templates -To include a template into an HTML file, you would simply add -`#{}` to the HTML document, where `` is the name of the +To include a template into an HTML file, you would simply add the line +`#/` to the HTML document where `` is the name of the template file relative to the `_templates/` directory. For example, supposing the following file structure: @@ -41,7 +41,7 @@ supposing the following file structure: /_templates/header.html In order to include `header.html` into the `index.html` document, one -would write `#{header.html}` within `index.html`, and likewise could be +would write `#/header.html` within `index.html`, and likewise could be done with `footer.html`. ## Variables @@ -52,15 +52,14 @@ be defined in each individual page, and referenced in the templates. All variables are strings. To define a variable in an HTML file, a section must be declared at the -beginning of the file which starts and ends with `%%%`. Within this -section, variables are declared and defined by the syntax -`=`. Note that there is no need to use quotes, as -everything after the `=` is considered part of the string until the end -of the line. These variables can then be used in the template files -which are imported with the syntax `${}`. For example: +beginning of the file which ends with `%%%`. Within this section, +variables are declared and defined by the syntax `=`. Note +that there is no need to use quotes, as everything after the `=` is +considered part of the string until the end of the line. These variables +can then be used in the template files which are imported with the +syntax `${}`. For example: index.html: - %%% my-title=Home Page %%% #{header.html}