汉化说明
本文档基于 https://github.com/kana112233/intellij-sdk-docs-cn 的 热心工作并有修改, 原始文档和本项目文档均遵循Apache开源协议. 需要说明的是JetBrains的最新插件开发文档已经不支持对外提供编译支持, 无法本地编译运行预览.
付费插件开发文档请阅读官方英文文档, 暂时未有计划翻译. https://plugins.jetbrains.com/docs/marketplace/
Markdown 文档必须符合YAMl格式,否则会报错, 请阅读: SDK文档的书写风格
导航边栏请修改此文件 _SUMMARY.md
BeanSoft@126.com, 网名 BeanSoft, 资深架构师, 曾就职于甲骨文北京, 易到用车等公司, 业余热爱IDEA插件开发与汉化, 荣获 JetBrains Community Contributor 社区贡献者称号.
BeanSoft开发的插件: https://plugins.jetbrains.com/organizations/BeanSoft
B站视频: IDEA插件社区
QQ技术交流群：209711104
部署编译 rake build[_config.yml]
IntelliJ Platform SDK Documentation
Welcome to the repository for IntelliJ Platform SDK Documentation site.
Feedback
Please report any content inconsistencies, outdated materials, cosmetic issues, and other defects using the channels listed in Getting Help.
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 its 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.