From 7919ece3ec443252c219517394eef3a459643a7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milan=20Felix=20=C5=A0ulc?= Date: Fri, 23 Jul 2021 20:38:46 +0200 Subject: [PATCH] Readme++ --- .docs/README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/.docs/README.md b/.docs/README.md index 43b3a24..cd84cea 100644 --- a/.docs/README.md +++ b/.docs/README.md @@ -1,19 +1,15 @@ -# Contributte\Anabelle +# Contributte Anabelle ## Content - [Api documentation generator \(JSON-RPC / REST\)](#api-documentation-generator-json-rpc--rest) - [How to use anabelle](#how-to-use-anabelle) - [Generator workflow](#generator-workflow) - +- [Examples](#examples) ## Api documentation generator (JSON-RPC / REST) -(No matter whether you're using REST or JSON-RPC or some other api architecture/scheme) - -### Example (demo) - -There is an example repository: [here](http://github.com/planette/playground/tree/master/contributte-anabelle). Generated documentation can be viewed here: [examples.contributte.org/packages/anabelle/](https://examples.contributte.org/packages/anabelle/). +No matter whether you're using REST or JSON-RPC or some other api architecture/scheme ### Extended Markdown syntax @@ -128,3 +124,10 @@ vendor/bin/anabelle docs-src docs --httpAuthUser user -httpAuthPass pass 1. `

` can be used wherever you want in the sidebar 1. `@` and `@@` sections are rendered in the sidebar nav 1. Content of `@` and `@@` sections is rendered into separate files and loaded into the main section detail after clicking particular section link in the nav + +## Examples + +- http://github.com/planette/playground/tree/master/contributte-anabelle (example project) +- https://examples.contributte.org/packages/anabelle/ (generated documentation) +- https://github.com/contributte/playground (playground) +- https://contributte.org/examples.html (more examples)