Skip to content

Commit

Permalink
Restructuring docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fadado committed Apr 1, 2017
1 parent 8e9c87d commit aa88356
Show file tree
Hide file tree
Showing 24 changed files with 7 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Common := \
$(Blocks)/*/markup.html \
$(Layouts)/default.html \
$(Content)/LINKS.txt \
filters.jq \
blocks/filters.jq \
content/markup.m \

# Files to "build"
Expand All @@ -89,7 +89,7 @@ JQT = jqt $(JQTFLAGS)
JQTFLAGS := \
-5 \
-I./ \
-ifilters \
-iblocks/filters \
-msite:$(Meta)/config.json \
-msnippets:$(Meta)/snippets.json \
--toc-depth=4 \
Expand Down
8 changes: 5 additions & 3 deletions docs/content/README.txt → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
File extension conventions
==========================
## Extension conventions for content files

The files in the `content` directory must follow some conventions in the file
extensions:

* Web site pages
- content.md
Expand All @@ -12,7 +14,7 @@ File extension conventions
- EXAMPLE.txt
- FLOW.txt
- LINKS.txt
- opt/*.txt
- opt/\*.txt

* MarkDown snippets
- snippets.yaml
Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion docs/content/opt/4.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-4, -5
: Sets the output HTML version (HTML4 / HTML5).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/C.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-C
: Stops processing before the render stage and outputs the full JSON data model.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/D.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-D NAME=VAL
: Defines the user macro *NAME* as equal to *VAL*.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/H.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-H
: Stops MarkDown processing after generating HTML (outputs several HTML fragments).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/I.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
-I DIRECTORY
: Appends *DIRECTORY* to the end of the preprocessor list of directories to be
searched for include files.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/L.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
-L DIRECTORY
: Appends *DIRECTORY* to the end of the jq list of directories to be searched
for included and imported modules.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/M.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
-M NAME:FILE
: Adds a *FILE* in YAML or JSON format to the input data at the top level
(*NAME* is ignored but must be present and unique).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/P.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
-P LANGUAGE
: Expands input file with the macro-processor (*LANGUAGE* can be `jqt`, `md`,
`json`, `css` or `css-min`).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/S.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-S
: Stops template processing before the render stage (outputs the jq script).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/T.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
: Transforms front matter YAML top level MarkDown scalar values to HTML.
If *NAME:FILE* is provided add the transformed data to the input data as a value of object *NAME*.
Otherwise, outputs a new YAML document.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/V.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-V, --version
: Displays version information.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/d.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-d FILE
: Reads the content document from *FILE*.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/e.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-e
: Extracts and outputs the MarkDown document YAML front matter.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/h.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-h, --help
: Displays this message.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/i.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-i MODULE
: Includes the jq *MODULE* in the render stage.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/j.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-j MODULE:NAME
: Imports the jq *MODULE* in the render stage.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/m.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-m NAME:FILE
: Adds a *FILE* in YAML or JSON format to the input data as the value of object *NAME*.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/n.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-n NAME
: Defines the name for YAML document metadata in _jq_ scripts (defaults to `page`).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/p.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-p
: Prints list of Pandoc accepted options.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/r.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-r
: Removes the MarkDown document YAML front matter and outputs the document body.

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>
1 change: 0 additions & 1 deletion docs/content/opt/t.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
-t
: Tests presence of front matter in MarkDown (indicated in the output status).

<#
vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown
#>

0 comments on commit aa88356

Please sign in to comment.