From 5fc3c298c174b1379f6b3ea9f67ad8ee5c8092cd Mon Sep 17 00:00:00 2001 From: Tim Sharpe Date: Fri, 1 Oct 2010 16:10:24 +1000 Subject: [PATCH] Some docs for the README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5100bb18..9dc3a0ea 100644 --- a/README.md +++ b/README.md @@ -307,6 +307,19 @@ Gollum uses [MathJax](http://www.mathjax.org/) to convert the TeX syntax into 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 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. If necessary, rebase your commits into logical chunks, without errors 1. Push the branch up to GitHub -1. Send me (mojombo) a pull request for your branch \ No newline at end of file +1. Send me (mojombo) a pull request for your branch