The Cayenne documentation system
I will be walking you through editing content from Cayenne's boutiful Documentation setup. This is a work-in-progress, and collaboration is always encouraged.
Markdown Cheatsheet (the syntax we will be using)
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
MacDown (Markdown editor for Mac)
http://macdown.uranusjr.com/
This section will highlight the common actions you might take while editing the docs. The instructions below describe the process using GitHub's built-in web editor.
Are you looking for the Staging version of the Docs? On the main repo page, right above the files, select the dropdown labeled Branch. From there, select the Staging branch. You are now in the Staging version of the Docs.
Let's say you find something incorrectly written or you would like to update some text. First, you would find the main section the article is located in.
We'll use Getting Started for our example:
Image Example Code
<p style="text-align:center"><br/><img src="IMAGE_URL" width="WIDTH" height="HEIGHT" alt="ALT"><br/><br/></p>
If you need to add additional anchor links to a section in the Docs, use the sample code below and fill in the anchor link (e.g. #apis) without the # sign.
In this example, we're linking to a fictional #help-me section
<p id="help-me" class="anchor-link"></p>
Sample code for copy + pasting purposes
<p id="ANCHOR_LINK_HERE" class="anchor-link"></p>