Skip to content

Commit

Permalink
Added paragraph after main heading
Browse files Browse the repository at this point in the history
  • Loading branch information
fadado committed Oct 2, 2016
1 parent bbe6d9a commit afa1f59
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/content/content.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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,
Expand Down
5 changes: 5 additions & 0 deletions docs/content/data.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/content/engine.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -9,6 +10,11 @@ updated: "2016-08-28T10:27:09Z"

# Template engine

As the [Wikipedia says](https://en.wikipedia.org/wiki/Template_processor),
<q><i>a template engine is
software designed to combine one or more templates with a data model to produce
one or more result documents</i></q>. _jqt_ fully satisfies this definition.

## Implementation

_jqt_ orchestrates several shell utilities to transform [MarkDown][MARKDOWN] text and
Expand Down
7 changes: 1 addition & 6 deletions docs/content/home.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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_.

<details>

<summary>
If you want to learn to use _jqt_ [install _jqt_](./engine.html#installation) and
read all the different site sections:
</summary>

* [Template engine](./engine.html)
* [Page structure](./structure.html)
Expand All @@ -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)!

</details>

_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
Expand Down
4 changes: 4 additions & 0 deletions docs/content/structure.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down

0 comments on commit afa1f59

Please sign in to comment.