hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

[site] markup, toc, summary.md

Browse Source
This commit is contained in:
Anna Bulenkova 2015-04-28 10:41:26 +02:00
parent 9a5d81d5e9
commit aedb4cd2f4
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
contribution_guidelines.md
View File

@ -18,10 +18,33 @@ article on GitHub explains how to do it.
To build and run the project locally you need to set up its development environment,
Refer to the
[README](https://github.com/JetBrains/intellij-sdk-docs/blob/master/README.md)
section of this project.
section of this project.
## Project Structure
### Markup
Documents are written in
[Markdown](https://en.wikipedia.org/wiki/Markdown)
markup template language.
Processing of Markdown source code and conversion into HTML is made by
[Kramdown](http://kramdown.gettalong.org/syntax.html) 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](https://github.com/JetBrains/intellij-sdk-docs/blob/master/_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
## Project Structure