Giter Club home page Giter Club logo

verto-docs's Introduction

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

verto-docs's People

Contributors

victor-torres avatar thehunmonkgroup avatar stefanyohansson avatar italorossi avatar royalpinto avatar phsultan avatar

Watchers

James Cloos 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.