Some docs for the README
This commit is contained in:
@@ -307,6 +307,19 @@ Gollum uses [MathJax](http://www.mathjax.org/) to convert the TeX syntax into
|
|||||||
output suitable for display in web browsers.
|
output suitable for display in web browsers.
|
||||||
|
|
||||||
|
|
||||||
|
## SEQUENCE DIAGRAMS
|
||||||
|
|
||||||
|
You may imbed sequence diagrams into your wiki page (rendered by
|
||||||
|
[WebSequenceDiagrams](http://www.websequencediagrams.com) by using the
|
||||||
|
following syntax:
|
||||||
|
|
||||||
|
{{{ blue-modern
|
||||||
|
alice->bob: Test
|
||||||
|
bob->alice: Test response
|
||||||
|
}}}
|
||||||
|
|
||||||
|
You can replace the string "blue-modern" with any supported style.
|
||||||
|
|
||||||
## API DOCUMENTATION
|
## API DOCUMENTATION
|
||||||
|
|
||||||
The Gollum API allows you to retrieve raw or formatted wiki content from a Git
|
The Gollum API allows you to retrieve raw or formatted wiki content from a Git
|
||||||
@@ -432,4 +445,4 @@ your changes merged back into core is as follows:
|
|||||||
1. Do not change the version number, I will do that on my end
|
1. Do not change the version number, I will do that on my end
|
||||||
1. If necessary, rebase your commits into logical chunks, without errors
|
1. If necessary, rebase your commits into logical chunks, without errors
|
||||||
1. Push the branch up to GitHub
|
1. Push the branch up to GitHub
|
||||||
1. Send me (mojombo) a pull request for your branch
|
1. Send me (mojombo) a pull request for your branch
|
||||||
|
|||||||
Reference in New Issue
Block a user