Giter Site home page Giter Site logo

prigara / intellij-sdk-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jetbrains/intellij-sdk-docs

0.0 2.0 0.0 16.15 MB

IntelliJ SDK Platform Documentation

Home Page: http://www.jetbrains.org/intellij/sdk/docs/

License: Apache License 2.0

Ruby 1.38% Java 91.31% HTML 0.38% Kotlin 0.41% Lex 1.14% GCC Machine Description 5.37%

intellij-sdk-docs's Introduction

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

###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

intellij-sdk-docs's People

Contributors

06needhamt avatar artspb avatar boogiecat avatar breandan avatar chashnikov avatar cheptsov avatar citizenmatt avatar develar avatar gauthierplm avatar hhariri avatar ignatov avatar kisenka avatar matklad avatar mikhailvink avatar obfuskator avatar rvishnyakov avatar vsch avatar yanncebron avatar yole avatar zjhmale avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.