Verto jQuery library documentation.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_pages
_posts
bin
css
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
_config.yml
contributors.txt
index.md

README.md

Verto documentation

Verto documentation uses markdown and is built with Jekyll, a simple, blog-aware, static site generator perfect for personal, project, or organization sites. View it live clicking here.

Installing dependencies

bundle install

Note: you may need to use RVM to install ruby and then execute gem install bundle before executing the command above, specially on Mac OS X.

Running Verto docs server

Inside verto docs directory and after installing Jekyll run:

jekyll serve

Now you can access http://127.0.0.1:4000/ and live preview verto docs while you edit its files. The server auto reloads when something changes.

Creating new pages

Our documentation follows a very simple convention of defining categories that correspond to sections in the navigation bar. They are:

  • doc - Documentation
  • ref - Reference
  • tut - Tutorial
  • dev - Developers

Inside verto docs directory run:

ruby bin/jekyll-page "Some Doc Page Title" doc