hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Replaced pygments syntax highlighter with rouge

Browse Source 
No more Python!

Updated to JetBrains/sdkdocs-template@b89d456a51
This commit is contained in:
Matt Ellis 2015-12-15 16:28:22 +00:00
parent efb046b7a8
commit 56b81cc8c1
5 changed files with 73 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -60,12 +60,11 @@ In order to build the documentation site, you will need:
* Ruby 2 - Jekyll is a Ruby application.
* Ruby 2 DevKit (for Windows) - Some of Jekyll's dependencies need to be compiled, and require the DevKit to be installed.
* Python 2 - the [Pygments](https://github.com/tmm1/pygments.rb) gem uses Python for syntax highlighting.
* `gem install bundler` - the site uses [Bundler](http://bundler.io) to manage gem dependencies within the repo, rather than globally installing to the local operating system. Run this command to install the Bundler toolset globally.
**OS X**
OS X comes with Ruby and Python already installed. The only steps required are:
OS X comes with Ruby already installed. The only steps required are:
* `gem install bundler`
@ -73,7 +72,6 @@ OS X comes with Ruby and Python already installed. The only steps required are:
* Install [Ruby 2](http://rubyinstaller.org) and the [Ruby 2 DevKit](http://rubyinstaller.org/downloads/) (one of the gems needs to build a native component)
* After installing the DevKit, make sure to edit the `config.yml` file to point to the Ruby installation
* Install [Python 2](https://www.python.org/downloads/windows/) (2.7 is recommended)
This is made easier if you use [Chocolatey](https://chocolatey.org), a package manager for Windows:
@ -82,7 +80,6 @@ This is made easier if you use [Chocolatey](https://chocolatey.org), a package m
* After installing the DevKit, make sure to edit the `config.yml` file to point to the Ruby installation.
* By default, this is `C:\tools\DevKit\config.yml`
* Add the line `- C:\tools\ruby21` (including the leading minus sign)
* `choco install python2`
> **NOTE** Before running the `rake bootstrap` step listed below, please run the `devkitvars.bat` file from the DevKit. E.g. `C:\tools\DevKit\devkitvars.bat`
@ -105,7 +102,7 @@ By default, when building the site, all files are copied to the destination `_si
However, only markdown files beginning with a [YAML](http://yaml.org) header are converted. If the markdown file doesn't contain a header, it won't be converted. In other words, to convert a `.md` file to HTML, it should look like this:
```
```md
---
---
@ -118,7 +115,7 @@ The two lines at the top of the file are the markers of the YAML "front matter".
The YAML header can contain data that is used when generating the site. For example, the page title can be specified as a simple piece of markdown - `# Title`, or it can be specified in the YAML, and the page template will display it appropriately:
```
```md
---
title: The Title Of The Page
---
@ -132,7 +129,7 @@ The YAML header can also include [redirect](#redirects) information.
The table of contents for the site is displayed in the tree view on the left hand side of the site, and it is generated from the `_SUMMARY.md` file. It is a simple markdown list, with each item in the list being a link to another markdown page, either in the root folder, or sub-folders. The list can have nested items, which will be displayed as child items in the table of contents.
```
```md
# Summary
* [Introduction](README.md)
@ -142,7 +139,7 @@ The table of contents for the site is displayed in the tree view on the left han
The contents can be split into "parts" by separating the list into several lists, each new list starting with a level 2 heading (`##`).
```
```md
# Summary
* [Introduction](README.md)
@ -160,7 +157,7 @@ If a node doesn't have a link, but is just plain text, it will still appear in t
The documentation site is set up to include the [jekyll-redirect-from](https://github.com/jekyll/jekyll-redirect-from) plugin, which will generate "dummy" pages that automatically redirect to a given page. For example, to specify that the `index.html` page will be generated to redirect to `README.md`, the `README.md` file should include the following in the YAML header:
```
```md
---
redirect_from:
- /index.html
@ -181,7 +178,7 @@ The site is configured to use the [Kramdown Markdown converter](http://kramdown.
One useful attribute is `{:toc}`, which can be applied to a list item, which will get replaced with a list of links to header items. E.g. the following list item will be replaced by links to all of the header items in the page:
```
```md
* Dummy list item
{:toc}
```
@ -210,7 +207,9 @@ Syntax highlighting can be applied by specifying the language after the first se
// Some Java code
```
Here is the list of [supported languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
Here is the list of [supported languages](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers) (and also [Kotlin](https://kotlinlang.org), of course).
<!-- Not currently supported by rouge, or by the site's CSS
The site is also configured to highlight a range of files in the source code, by specifying `{start-end}` which is the start and end line of the highlighting:
@ -220,6 +219,7 @@ The site is also configured to highlight a range of files in the source code, by
// Highlighted
// Not highlighted
```
-->
### Tables
@ -253,7 +253,7 @@ Will be displayed as a callout, styled as a "note". The other styles available f
Images can be included by adding the file directly to the repository and adding a link to the image like so:
```
```md
![Alt text](path-to-img.png)
```

60
Gemfile.lock
View File

@ -18,29 +18,36 @@ GIT
nokogiri (~> 1.6)
trollop (~> 2.0)
GIT
remote: https://github.com/citizenmatt/rouge.git
revision: 0786e898fd66805ddf1e965c4aa472d6a89d70ce
branch: multiple_fixes
specs:
rouge (1.10.1)
GEM
remote: https://rubygems.org/
specs:
addressable (2.3.8)
anemone (0.7.2)
nokogiri (>= 1.3.0)
robotex (>= 1.0.0)
blankslate (2.1.2.4)
celluloid (0.16.0)
timers (~> 4.0.0)
certified (1.0.0)
classifier-reborn (2.0.3)
classifier-reborn (2.0.4)
fast-stemmer (~> 1.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.9.1.1)
coffee-script-source (1.10.0)
colorator (0.1)
colorize (0.7.7)
execjs (2.5.2)
execjs (2.6.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
fast-stemmer (1.0.2)
ffi (1.9.10)
ffi (1.9.10-x64-mingw32)
hitimes (1.2.2)
jekyll (2.5.3)
classifier-reborn (~> 2.0)
colorator (~> 0.1)
@ -58,26 +65,29 @@ GEM
toml (~> 0.1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-gist (1.2.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.8.0)
jekyll-redirect-from (0.9.1)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-watch (1.2.1)
listen (~> 2.7)
kramdown (1.8.0)
liquid (2.6.2)
listen (2.10.1)
celluloid (~> 0.16.0)
jekyll-watch (1.3.0)
listen (~> 3.0)
kramdown (1.9.0)
liquid (2.6.3)
listen (3.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
mercenary (0.3.5)
mini_portile (0.6.2)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
nokogiri (1.6.6.2-x64-mingw32)
mini_portile (~> 0.6.0)
mini_portile2 (2.0.0)
multipart-post (2.0.0)
nokogiri (1.6.7)
mini_portile2 (~> 2.0.0.rc2)
nokogiri (1.6.7-x64-mingw32)
mini_portile2 (~> 2.0.0.rc2)
octokit (4.2.0)
sawyer (~> 0.6.0, >= 0.5.3)
parslet (1.5.0)
blankslate (~> 2.0)
posix-spawn (0.3.11)
@ -85,15 +95,16 @@ GEM
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.2.0)
rake (10.4.2)
rb-fsevent (0.9.5)
rb-fsevent (0.9.6)
rb-inotify (0.9.5)
ffi (>= 0.5.0)
redcarpet (3.3.2)
redcarpet (3.3.3)
robotex (1.0.0)
safe_yaml (1.0.4)
sass (3.4.16)
timers (4.0.1)
hitimes
sass (3.4.20)
sawyer (0.6.0)
addressable (~> 2.3.5)
faraday (~> 0.8, < 0.10)
toml (0.1.2)
parslet (~> 1.5.0)
trollop (2.1.2)
@ -109,3 +120,4 @@ DEPENDENCIES
jekyll-redirect-from
link-checker!
rake
rouge!

48
basics/plugin_structure/plugin_content.md
View File

@ -8,33 +8,33 @@ There are two possible ways of organizing plugin content:
The archive should contain the configuration file (`META-INF/plugin.xml`) and classes that implement the plugin functionality. The configuration file specifies the plugin name, description, version, vendor, the supported IntelliJ IDEA version, plugin components, actions and action groups, and action user interface placement.
```
.IntelliJIDEAx0
plugins
sample.jar/
com/foo/...
...
...
META-INF
plugin.xml
```
```
.IntelliJIDEAx0/
plugins/
sample.jar/
com/foo/...
...
...
META-INF/
plugin.xml
```
2. Plugin files located in a `.jar` file that is placed in the lib folder:
```
.IntelliJIDEAx0
plugins
Sample
lib
libfoo.jar
libbar.jar
Sample.jar/
com/foo/...
...
...
META-INF
plugin.xml
```
```
.IntelliJIDEAx0/
plugins/
Sample/
lib/
libfoo.jar
libbar.jar
Sample.jar/
com/foo/...
...
...
META-INF/
plugin.xml
```
All jars from the `lib` folder are automatically added to the classpath.

1
basics/plugin_structure/plugin_extensions_and_extension_points.md
View File

@ -11,7 +11,6 @@ If you want your plugin to allow other plugins to extend its functionality, in t
## Extensions
If you want your plugin to extend the functionality of other plugins or the *IntelliJ Platform*, you must declare one or several _extensions_.
If you want your plugin to extend the functionality of other plugins or the *Intell iJ Platform*, you must declare one or several _extensions_.
## How to declare extensions and extension points

2
sdkdocs-template

@ -1 +1 @@
Subproject commit 20ff87b1a02455b22e2a2a19a57528bc73505415
Subproject commit b89d456a5174c77f4c8450d8cb88ed14cc458693