README.md: cleanup

This commit is contained in:
Yann Cébron 2019-02-22 16:00:58 +01:00
parent 813492a256
commit 42be759c39

View File

@ -4,9 +4,7 @@
IntelliJ Platform SDK Documentation
=======
This is a repository for
[IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/)
site.
Welcome to the repository for [IntelliJ Platform SDK Documentation](http://www.jetbrains.org/intellij/sdk/docs/) site.
## 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
@ -47,7 +45,7 @@ git clone https://github.com/JetBrains/intellij-sdk-docs.git
### Initializing Submodules
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.
```bash
@ -56,10 +54,10 @@ git submodule update --init --remote
### 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
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