thibaultclem / developer.exoplatform.org

developer.exoplatform.org

Home Page:http://developer.exoplatform.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

developer.exoplatform.org

This site groups together all documentations useful to develop or contribute to eXo Platform projects. It is built using Jekyll and deployed on Github Pages.

How to contribute ?

Feel free to fork the repository and submit pull requests.

How to install the environment ?

  1. Install RVM and ruby
curl -sSL https://get.rvm.io | bash -s stable

rvm install 2.1.1

rvm use 2.1.1
  1. Install Github Pages which will Install Jekyll too. In your developer.exoplatform.org local clone directory just call :
gem install bundler

bundle install 
  1. In order to update jekyll and related in the future :
bundle update

How to create a new post ?

rake post title="A Title"
rake post title="A Title" date="2012-02-09"
rake post title="A Title" tags=[tag1,tag2]
rake post title="A Title" category="category"
rake post title="A Title" date="2012-02-09" tags=[tag1,tag2] category="category"

How to create a new page ?

rake page name="about.md"

You can also specify a sub-directory path. If you don't specify a file extension we create an index.html at the path specified

How to preview the site ?

In order to get a server up and running with your Jekyll site, run:

rake preview

and then browse to http://localhost:4000.

Useful resources

License

Creative Commons BY-NC-SA

About

developer.exoplatform.org

http://developer.exoplatform.org


Languages

Language:HTML 65.9%Language:CSS 22.9%Language:Ruby 9.5%Language:JavaScript 1.7%