diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-12-13 00:07:39 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-12-13 00:07:39 +0000 |
| commit | 2a4a133b88402a513f1e2cbdd1c5dc29d057b8d5 (patch) | |
| tree | 717130a0665c4936d2f83f76a011b4424cd6a36d /docs/antora.yml | |
| parent | 052abc918a987acb35d44dcd91d9db8a8aaf8ece (diff) | |
| parent | ff82c76935d86b7444e6abc7296c4c3e09261484 (diff) | |
Merge #533
533: Book poc r=Dirbaio a=lulf
This is a Proof of Concept for an embassy book. It's using Antora/Asciidoc.
* Asciidoc because it's a single specification with a slightly richer feature set than markdown.
* Antora because it allows keeping content in the embassy repo, while book definition in another repo (embassy-book).
Using antora also allows for easy embedding of embassy doc in other projects, which I think in turn increases probability of upstream contributions.
The sources of content are located in docs/ but could also be in a separate repo. However, keeping it in the embassy repo makes it easier to support one version of the book per embassy version in the future.
At present, the book is automatically built every hour from this branch and published at: https://embassy-rs.github.io/embassy-book/embassy/dev/index.html
Co-authored-by: Ulf Lilleengen <[email protected]>
Co-authored-by: Ulf Lilleengen <[email protected]>
Diffstat (limited to 'docs/antora.yml')
| -rw-r--r-- | docs/antora.yml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 000000000..807c97c3f --- /dev/null +++ b/docs/antora.yml | |||
| @@ -0,0 +1,5 @@ | |||
| 1 | name: embassy | ||
| 2 | title: Embassy | ||
| 3 | version: dev | ||
| 4 | nav: | ||
| 5 | - modules/ROOT/nav.adoc | ||