Skip to content

Commit

Permalink
Some docs writing guidlines
Browse files Browse the repository at this point in the history
  • Loading branch information
synhershko committed Apr 12, 2012
1 parent b7e2a51 commit 0f3db1d
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions readme
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
This repository is for the RavenDB documenation
This repository contains the official RavenDB documenation

The compiled old book can be downloaded as a PDF from
http://builds.hibernatingrhinos.com/download/2254
The compiled old book can still be downloaded as a PDF from [http://builds.hibernatingrhinos.com/download/2254](http://builds.hibernatingrhinos.com/download/2254)

The documentation is written using the [Markdown language](http://en.wikipedia.org/wiki/Markdown), and may use some extended Markdown features.

* Images should be stored under a local "images" folder, right below the document referencing them. The reference should be to "images/image_name.png". Image names should bear a unique descriptive name, like clientapi_intro_serverimage.png.

* Links to other documents within the documentation system should be relative, without the .markdown extension, e.g. href="../../server/deployment".

The following non-standard syntax is supported as well:

* For code blocks (supported: json, csharp):

{CODE-START:json /}
...
{CODE-END /}

* For highlighted blocks:

{BLOCK ... /}
{NOTE ... /}
{INFO ... /}
{WARNING ... /}
{TIP ... /}
{WARNING ... /}

* For a files list - will output a list of links to all child documents:

{FILES-LIST /}

0 comments on commit 0f3db1d

Please sign in to comment.