Skip to content

Commit

Permalink
Readme++
Browse files Browse the repository at this point in the history
  • Loading branch information
f3l1x committed Jul 23, 2021
1 parent 960debc commit 7919ece
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions .docs/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -128,3 +124,10 @@ vendor/bin/anabelle docs-src docs --httpAuthUser user -httpAuthPass pass
1. `<h2>` 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)

0 comments on commit 7919ece

Please sign in to comment.