2.8 KiB
| title |
|---|
| Contribution Guidelines |
This document explains how to contribute changes to the IntelliJ SDK Platform Documentation project.
Licensing
Project source code terms of use, reproduction, and redistribution is defined by Apache 2.0 license
Contributing Changes
Uses with Write Access
To contribute your changes clone the project, implement your changes, and push them to the repository.
User with Read-Only Access
To contribute you changes use a pull request. Creating a pull request article on GitHub explains how to do it.
Setting Up Environment
To build and run the project locally you need to set up its development environment, Refer to the README section of this project.
Project Structure
The project contain the following major types of content:
- Articles An article describes some part of the API and general rule of using it in a free form.
- Step-by-step tutorials
- Code samples
Markup
Documents are written in Markdown markup template language. Processing of Markdown source code and conversion into HTML is made by Kramdown library.
Creating an Article
To post an article, create a Markdown document inside of the project directory structure. Jekyll engine will process all the Markdown files inside the project and create corresponding static HTML pages with same relative paths for them. To process a Markdown file you need to refer to it's HTML counterpart in _SUMMARY.md
Table of Contents and _SUMMARY.md
File _SUMMARY.md located in the root directory defines project's hierarchical structure displayed on the left side of the page in a tree form. Place the name of an article and a link relatively to the site root to the correcponding HTML document to _SUMMARY.md to list the article in TOC. Headers without links to corresponding files won't be visible. Files not included in the listing wont be processed.
Formatting Rules
Text
To make the source code easy to read, start every new sentence from a new line. Avoid semicolons, long sentences, and complicated formulations.
Links
Place every link separately on a new line
Please refer to the
[following article](http://link.address)
to get more information