summaryrefslogtreecommitdiff
path: root/index.mdwn
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-06-09 07:00:08 +0300
committerLars Wirzenius <liw@liw.fi>2021-06-09 07:35:54 +0300
commit584e728e62bd37933800cb2f746cfdea1f7791b1 (patch)
tree3ce6aee4ac3ce2d1494fc8a44e2c2570c31d03a7 /index.mdwn
parent01401ef257152ba04936b33977b4ef5bed4ec450 (diff)
downloadsubplot.liw.fi-584e728e62bd37933800cb2f746cfdea1f7791b1.tar.gz
refactor: drop list of examples, point at doc.subplot.liw.fi instead
Also, add missing metadata to inlined example. Sponsored-by: author
Diffstat (limited to 'index.mdwn')
-rw-r--r--index.mdwn30
1 files changed, 16 insertions, 14 deletions
diff --git a/index.mdwn b/index.mdwn
index 4c5d202..f4a93c4 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -52,11 +52,20 @@ to abide by its terms.
## Examples
-This is a pretty minimal example.
+The [documentation][] site has examples that are from the Subplot
+source repository and typeset and tested by CI, so they're always up
+to date. This means the examples always work.
+
+[documentation]: https://doc.subplot.liw.fi/
+
+Below is a pretty minimal example.
~~~~~{.markdown .numberLines}
---
title: "**echo**(1) acceptance tests"
+template: python
+bindings: echo.yaml
+functions: echo.py
...
Introduction
@@ -90,27 +99,20 @@ then standard error is empty
See actual, working, tested examples:
* The Unix echo command
- ([html](https://examples.subplot.liw.fi/echo.html),
- [PDF](https://examples.subplot.liw.fi/echo.pdf),
+ ([html](https://doc.subplot.liw.fi/echo.html),
+ [PDF](https://doc.subplot.liw.fi/echo.pdf),
[source](https://gitlab.com/subplot/subplot/-/blob/main/echo.md)).
* A hypothetical JSON store with access control and a web API
- ([html](https://examples.subplot.liw.fi/muck.html),
- [PDF](https://examples.subplot.liw.fi/muck.pdf),
+ ([html](https://doc.subplot.liw.fi/muck.html),
+ [PDF](https://doc.subplot.liw.fi/muck.pdf),
[source](https://gitlab.com/subplot/subplot/-/blob/main/muck.md)).
* Subplot's own acceptance criteria, a non-trivial example
- ([html](https://examples.subplot.liw.fi/subplot.html),
- [PDF](https://examples.subplot.liw.fi/subplot.pdf),
+ ([html](https://doc.subplot.liw.fi/subplot.html),
+ [PDF](https://doc.subplot.liw.fi/subplot.pdf),
[source](https://gitlab.com/subplot/subplot/-/blob/main/subplot.md)).
-The [examples][] site may have more examples, if we forget to list
-them here. These are generated automatically from the Subplot source
-repository by CI, so they're always up to date, and tested as part of
-Subplot's CI build, so they always work.
-
-[examples]: https://examples.subplot.liw.fi/
-
# A bonus kitten
Because you scrolled all the way down.