Skip to content

Commit

Permalink
update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Nov 12, 2018
1 parent 60a2e12 commit 73a299a
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions doc/api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@

The API currently only supports
`remark <https://github.com/gnab/remark>`__,
but in future
we plan to support also other rendering engines.


v3
==
Expand All @@ -14,8 +9,11 @@ This API is the future::

Examples:

- GitHub: https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/talk.md
- GitLab: https://cicero.xyz/v3/remark/0.14.0/gitlab.com/bast/cicero-example/master/demo/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/simple/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/styling/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/equations/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/original/talk.md
- https://cicero.xyz/v3/reveal.js/3.7.0/github.com/bast/cicero/master/demo/reveal.js/talk.md


v2
Expand All @@ -25,7 +23,7 @@ This API is currently the default::

/v2/remark/github/<namespace>/<repo>/<branch>/<path>

Example: https://cicero.xyz/v2/remark/github/bast/cicero/master/demo/talk.md
Example: https://cicero.xyz/v2/remark/github/bast/cicero/master/demo/remark/original/talk.md


v1
Expand Down

0 comments on commit 73a299a

Please sign in to comment.