From afa1f591bc0cc847764ac7bace1d8dd8676346b2 Mon Sep 17 00:00:00 2001 From: Joan Josep Ordinas Rosa Date: Sun, 2 Oct 2016 09:40:56 +0200 Subject: [PATCH] Added paragraph after main heading --- docs/Makefile | 2 +- docs/config.yaml | 3 +++ docs/content/content.md | 5 +++++ docs/content/data.md | 5 +++++ docs/content/engine.md | 6 ++++++ docs/content/home.md | 7 +------ docs/content/structure.md | 4 ++++ 7 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 0905a9c..311f78b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -138,7 +138,7 @@ DETAILS := sed \ $(Destination)/index.html: $(Content)/home.md $(Common) \ | $(Destination) $(info ==> $@) - $(JQT) -d $< $(Layouts)/default.html | $(DETAILS) > $@ + $(JQT) -d $< $(Layouts)/default.html > $@ $(foreach p,$(Pages),$(Destination)/$(p).html): $(Content)/FLOW.txt $(Content)/opt/*.txt $(Destination)/index.html $(Destination)/structure.html: $(Content)/EXAMPLE.txt diff --git a/docs/config.yaml b/docs/config.yaml index 5608782..4406eba 100644 --- a/docs/config.yaml +++ b/docs/config.yaml @@ -18,6 +18,9 @@ author: name: Joan Josep Ordinas Rosa menu: +- URL: ./index.html + path: content/home.md + name: Home - URL: ./engine.html path: content/engine.md name: Engine diff --git a/docs/content/content.md b/docs/content/content.md index 5624843..8a06888 100644 --- a/docs/content/content.md +++ b/docs/content/content.md @@ -1,4 +1,5 @@ --- +layout: page title: Authoring content in jqt using MarkDown description: jqt transforms MarkDown documents to HTML using Pandoc. keywords: jqt, markdown, pandoc, gpp, preprocessing, authoring content @@ -9,6 +10,10 @@ updated: "2016-08-28T10:27:09Z" # Authoring content +Authors must be freed from any concern regarding the presentation of his +writings, and his dedication to its structure must be the essential minimum: +_MarkDown_ promises and delivers exactly this. + ## General operation _jqt_ transforms [MarkDown][MARKDOWN] documents to HTML using Pandoc, diff --git a/docs/content/data.md b/docs/content/data.md index f624c49..3da0fd9 100644 --- a/docs/content/data.md +++ b/docs/content/data.md @@ -1,4 +1,5 @@ --- +layout: page title: Managing the data model with jqt description: jqt combines one template with one MarkDown document and a data model. keywords: jqt, JSON, YAML, gpp, preprocessing, data model @@ -9,6 +10,10 @@ updated: "2016-08-28T10:27:09Z" # Data model +The simplest page always resides on a website, where there is a complex web of +relationships between pages… as we have to imagine these relationships, we need +a way to represent them: this is the data model. + ## General operation _jqt_ is designed to combine one template with one [MarkDown][MARKDOWN] document and a diff --git a/docs/content/engine.md b/docs/content/engine.md index c6eda01..a23f838 100644 --- a/docs/content/engine.md +++ b/docs/content/engine.md @@ -1,4 +1,5 @@ --- +layout: page title: The jqt template engine description: jqt orchestrates several shell utilities to transform MarkDown text and YAML or JSON data into a final HTML page. keywords: jqt, jq, YAML, gpp, preprocessing, template engine @@ -9,6 +10,11 @@ updated: "2016-08-28T10:27:09Z" # Template engine +As the [Wikipedia says](https://en.wikipedia.org/wiki/Template_processor), +a template engine is +software designed to combine one or more templates with a data model to produce +one or more result documents. _jqt_ fully satisfies this definition. + ## Implementation _jqt_ orchestrates several shell utilities to transform [MarkDown][MARKDOWN] text and diff --git a/docs/content/home.md b/docs/content/home.md index 135922d..9395efd 100644 --- a/docs/content/home.md +++ b/docs/content/home.md @@ -1,4 +1,5 @@ --- +layout: default title: Welcome to jqt description: Could be jq the basis for a web template engine? keywords: jqt, jq, template engine @@ -63,12 +64,8 @@ example seems to be a template? This site is built using _jqt_, and is itself in his implementation a kind of tutorial about _jqt_. -
- - If you want to learn to use _jqt_ [install _jqt_](./engine.html#installation) and read all the different site sections: - * [Template engine](./engine.html) * [Page structure](./structure.html) @@ -77,8 +74,6 @@ read all the different site sections: And don't forget to study the source code under the [docs directory](https://github.com/fadado/jqt/tree/master/docs)! -
- _jqt_ is developed under the _Fedora_ Linux distribution, and a lot of portability issues are expected at this stage of development. Please, use the project [GitHub repository][REPO] features if you diff --git a/docs/content/structure.md b/docs/content/structure.md index 965b223..729ed2c 100644 --- a/docs/content/structure.md +++ b/docs/content/structure.md @@ -1,4 +1,5 @@ --- +layout: page title: Defining the page structure with jqt description: Web pages structure is defined by the HTML markup. keywords: jqt, jq, gpp, preprocessing, template engine @@ -9,6 +10,9 @@ updated: "2016-08-28T10:27:09Z" # Page structure +The same content can be delivered to the Web in different structured formats, and the +transformation of that content in the final pages must be completely automatic. + ## General operation Web pages structure is defined by the HTML markup, and using _jqt_ it is