a29e9b4e51
* Initial theme * JSON theme construction and integration with sdk project. Added theme documentation. * Added images and review feedback * Added internal mode and internal actions documentation * More feedback * Removed stub internal menu entries. * Reduced use of images, clarified IntelliJ Platform, IDE. * OlyaB feedback and compress images * Moved json file to resources folder * 19.1 -> 2019.1 * Strong note about availability of Custom UI Themes * Removed reference to UiDefaultsHardcodedKeys.java * Added IJSDK-567 content + cautioning UI Control keys may be deprecated. * Better SVG icons, clarify macOS scroll bar name attributes. * Generalize IntelliJ references, soften description of High Contrast scheme file as reference. * Updated custom color editor scheme descriptions. * Corrected position of editor scheme declaration.
IntelliJ Platform SDK Documentation
Welcome to the repository for IntelliJ Platform SDK Documentation site.
Reporting Bugs
Please report any content inconsistencies, outdated materials, cosmetic issues and other defects you find in the docs and samples by submitting an issue to YouTrack.
Working With the Site Locally
To check out and run a local copy of the site follow the steps described below.
Pre-requirements
-
Make sure you have a git client installed
-
This site requires Ruby 2.0 or higher. Follow the official Ruby language download and installation instructions to get Ruby working on your machine.
-
This site requires Jekyll, a Ruby-based site generating framework. To install Jekyll refer to it's installation guidelines. Note: If you are using Windows, you can face some specific aspects while installing Jekyll. See this Run Jekyll on Windows Guide to get more information.
Checking Out Site Repository
To check out the source code run the following command:
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. Run the following command in the checkout directory to do so.
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 additionally required gems.
Building and Previewing
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
- Make sure you are in a project root directory
- To build static site content run
rake build
Previewing
- To start the web-server run
rake preview - Open the address http://localhost:4000/intellij/sdk/docs/ in your browser. Note: Make sure you haven't changed default Jekyll port during installation.