IntelliJ SDK Platform Documentation
Clone or download
serejke Merge pull request #96 from pettermahlen/patch-1
Highlight API compatibility issues
Latest commit 3fc363b Sep 21, 2018
Permalink
Failed to load latest commit information.
.idea Refactored psi demo directory & module structure. Aug 6, 2018
basics Merge pull request #96 from pettermahlen/patch-1 Sep 21, 2018
code_samples Merge pull request #108 from JohnHake/master Aug 23, 2018
drafts First build for GH pages Jan 15, 2016
intro Fix broken link to api_changes_list.md Aug 15, 2018
phpstorm Clarified development/test tools vs. DevKit SDK basis Sep 13, 2018
platform Fixed broken links. Sep 6, 2018
plugin_repository Feature extractor -> plugin recommendations; remove irrelevant refere… Sep 14, 2018
products Menu: Part VII / IntelliJ IDEA Dec 20, 2017
reference_guide Merge pull request #109 from JohnHake/ijsdk-431 Sep 21, 2018
sdkdocs-template @ b5ae498 Update gem versions Feb 26, 2018
testData First build for GH pages Jan 15, 2016
tutorials Feature extractor -> plugin recommendations; remove irrelevant refere… Sep 14, 2018
user_interface_components Correct spelling Aug 30, 2018
xml_dom_api First build for GH pages Jan 15, 2016
.gitignore Update to sdkdocs-template@af7ffe3 Jun 13, 2017
.gitmodules Using sdkdocs-template instead of webhelp-template Jul 9, 2015
CONTRIBUTING.md Fix broken links (#42) Jul 14, 2017
Dockerfile Fix issue with missing bundler gem Mar 24, 2016
Gemfile Using sdkdocs-template instead of webhelp-template Jul 9, 2015
Gemfile.lock Update gem versions Feb 26, 2018
LICENSE.txt First build for GH pages Jan 15, 2016
README.md Add 'bundle install' to instructions Mar 11, 2018
Rakefile `FileUtils.cp_r` has inconsistent results on Windows and Linux Dec 28, 2015
_SUMMARY.md Merge pull request #109 from JohnHake/ijsdk-431 Sep 21, 2018
_config.yml Update config values Sep 19, 2017
basics.md Moved IDE settings, caches, logs, plugins link to Appendix I. Added I… Sep 13, 2018
config.json Set correct search scope in config Oct 4, 2017
container_settings.json First build for GH pages Jan 15, 2016
faq.md Update Scala plugin link Dec 4, 2017
intellij-sdk-docs.iml Update sdkdocs-template submodule and .gitignore Dec 5, 2015
resources.md Merge pull request #109 from JohnHake/ijsdk-431 Sep 21, 2018
welcome.md Feature extractor -> plugin recommendations; remove irrelevant refere… Sep 14, 2018

README.md

official JetBrains project

IntelliJ Platform SDK Documentation

This is a repository for IntelliJ Platform SDK Documentation 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 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 Gema

After you performed the initial checkout for the main repository and the submodule, run bundle install to install additional 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.

Building Site from Sources

  • Make sure you are in a project root directory
  • To build static site content run
    rake build
    

Previewing