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

README.md: cleanup

Browse Source
This commit is contained in:
Yann Cébron 2019-02-22 16:00:58 +01:00
parent 813492a256
commit 42be759c39
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,9 +4,7 @@
IntelliJ Platform SDK Documentation IntelliJ Platform SDK Documentation
======= =======
This is a repository for Welcome to the repository for [IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/) site.
[IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/)
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
@ -47,7 +45,7 @@ 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.
Run the following command in the checkout directory to do so. Run the following command in the checkout directory to do so.
```bash ```bash
@ -56,10 +54,10 @@ git submodule update --init --remote
### Installing Gems ### Installing Gems
After you performed the initial checkout for the main repository and the submodule, run `bundle install` to install additional required gems. After you performed the initial checkout for the main repository and the submodule, run `bundle install` to install additionally required gems.
### 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 program implemented in Ruby, provides short commands to build and run the site locally.
#### Building Site from Sources #### Building Site from Sources