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

Fix headers in readme

Browse Source
This commit is contained in:
Simon Ogorodnik 2017-05-16 13:34:22 +03:00 committed by GitHub
parent 1685099fc9
commit a7a33c35ce
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -5,14 +5,14 @@ This is a repository for
[IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/) [IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/)
site. site.
##Reporting Bugs ## Reporting Bugs
Please inform about any content inconsistencies, outdated materials, cosmetic issues and other defects you find in the docs and samples by submitting an issue to Please inform about any content inconsistencies, outdated materials, cosmetic issues and other defects you find in the docs and samples by submitting an issue to
[YouTrack](https://youtrack.jetbrains.com/issues/IJSDK). [YouTrack](https://youtrack.jetbrains.com/issues/IJSDK).
##Working With the Site Locally ## Working With the Site Locally
To check out and run a local copy of the site follow the steps described below. To check out and run a local copy of the site follow the steps described below.
###Pre-requirements ### Pre-requirements
* Make sure you have a * Make sure you have a
[git client](http://git-scm.com/downloads) [git client](http://git-scm.com/downloads)
@ -41,7 +41,7 @@ To check out the source code run the following command:
git clone https://github.com/JetBrains/intellij-sdk-docs.git git clone https://github.com/JetBrains/intellij-sdk-docs.git
``` ```
###Initializing Submodules ### Initializing Submodules
The site uses JetBrains custom web templates. The site uses JetBrains custom web templates.
To enable custom templates locally you need to initialize repository submodules. To enable custom templates locally you need to initialize repository submodules.
@ -51,10 +51,10 @@ Run the following command in the checkout directory to do so.
git submodule update --init --remote git submodule update --init --remote
``` ```
###Building and Previewing ### Building and Previewing
A set of Rake tasks, a Make-like programs implemented in Ruby, provides short commands to build and run the site locally. A set of Rake tasks, a Make-like programs implemented in Ruby, provides short commands to build and run the site locally.
####Building Site from Sources #### Building Site from Sources
* Make sure you are in a project root directory * Make sure you are in a project root directory
* To build static site content run * To build static site content run
@ -62,7 +62,7 @@ A set of Rake tasks, a Make-like programs implemented in Ruby, provides short co
rake build rake build
``` ```
####Previewing #### Previewing
* To start the web-server run * To start the web-server run
``` ```