From afdcecb52b11af99f0f661ce3c9cc57b12e18b86 Mon Sep 17 00:00:00 2001 From: SebastianMC Date: Sun, 7 Aug 2022 01:40:36 +0200 Subject: [PATCH] Documentation updates (downloadable examples for README.md). --- README.md | 5 ++++- docs/examples/1/sortspec.md | 5 +++++ docs/examples/5/sortspec.md | 8 ++++++++ 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/examples/1/sortspec.md create mode 100644 docs/examples/5/sortspec.md diff --git a/README.md b/README.md index b3b70e9..1b4f30e 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ the [ribbon icon](#ribbon_icon) section for details The specified rule is to sort items alphabetically -> IMPORTANT: indentation matters in all of the examples +> IMPORTANT: indentation matters in all the examples ```yaml --- @@ -67,6 +67,7 @@ sorting-spec: | < a-z --- ``` +(Download the [sortspec.md](./docs/examples/1/sortspec.md) file of this example) which can result in: @@ -176,6 +177,8 @@ sorting-spec: | --- ``` +(Download the [sortspec.md](./docs/examples/5/sortspec.md) file of this example) + which will have the effect of: ![Result of the example](./docs/svg/p_a_r_a.svg) diff --git a/docs/examples/1/sortspec.md b/docs/examples/1/sortspec.md new file mode 100644 index 0000000..b43009c --- /dev/null +++ b/docs/examples/1/sortspec.md @@ -0,0 +1,5 @@ +--- +sorting-spec: | + target-folder: / + < a-z +--- diff --git a/docs/examples/5/sortspec.md b/docs/examples/5/sortspec.md new file mode 100644 index 0000000..54a7e1e --- /dev/null +++ b/docs/examples/5/sortspec.md @@ -0,0 +1,8 @@ +--- +sorting-spec: | + target-folder: / + Projects + Areas + Responsibilities + Archive +---