About project

09 september 2016, 11:06

Open Source documentation for MODX Revolution

Purpose

The main purpose of this documentation is to give the opportunity to contribute for everyone. It is not needed to be logged in at once, to ask anybody for access, you simply send a commit to this repository, and it will be accepted.

We describe a 3rd party components and the core of MODX in two languages: Russian and English. If you are ready to manage documentation in another language, please contact us by creating issue.

Format

All files are written in the Markdown, the names are compatible with daux.io. At any moment you can clone this repository and deploy it on your server. Also you can read files directly on GitHub.

Rules of drawing up documents

Structure

The format of the repository is defined by the following structure:

  1. Language version
  2. Section
  3. Theme
  4. Further structure is defined depending on the theme
  5. To specify the order of the directories and files, we use the numeric prefixes.

Here is the path to the file with the description of a snippet HybridAuth on English:

/en/02_Components/04_HybridAuth/01_Snippets/01_HybridAuth

Headers

For the headlines we use hashtags ## and between them and the text put a space. For example: ## Header

Headlines should not be more h2, e.g - 2 hashtags ##:

  • h2 = ##
  • h3 = ###
  • h4 = ####

Between the header and the text from the top and one blank line. Between the header and the text of the bottom blank line not needed.

Links

Links to documents should be added to the end of the page to make it easy to search and update. In markdown this is accomplished by:

[Link][1]
[Name of another link][2]

[1]: http://mylink.com/
[2]: http://mylink.com/test.html

Among other things, this allows you to use one link multiple times on a page:

[Link 1][1]
[Link 2][1]

[1]: http://mylink.com/

Links to pages of the repository should start with a leading slash which specifies the root, then you can go directly on GitHub:

[Link to the english section of pdoTools][3]

[3]: /en/01_Components/01_pdoTools

Easier to open the desired page on GitHub and copy the address from the url.

The image links can be inserted directly in the text. To specify the image, and use the service on file.modx.pro (requires authorization). It automatically generates thumbnail and markdown code for insertion.

[![](https://file.modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559as.jpg)](https://file.modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559a.png)

Highlighting

System settings need to use bold text, for example: **&parametr** will look like &parametr.

Placeholders wrapped in single reverse apostrophes. For example: `[[+placeholder]]` will look like [[+placeholder]].

For block with code we using 3 reverse apostrophe ``` before and after:

```
Here is the code
```

The code starts from the new line. Blank lines before and after the code voluntarily.

Newline

For making the forced line break you need to add two spaces at the end of the line. Parser will replace them with the tag br.

Tables

You can use tables for easy display data, such as snippet properties:

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell
First Header Second Header
Content Cell Content Cell
Content Cell Content Cell