Git Product home page Git Product logo

documentation's Introduction

Locomotive Documentation Site

We woud appreciate any contribution to this guide.

How to contribute ?

Fork the repository and send us a pull request!

How to run the doc site locally

  • fork this repository
  • install the required gems bundle install
  • run the server bundle exec wagon serve
  • open your browser http://0.0.0.0:3333

What can I do to help?

Read the TODO :)

Conventions

  • alerts :
    • plain html inside, no haml parsed
    • "blue style" alert is a div with class .alert .alert-info
    • "orange style" alert is a div with class .alert. .alert-warning
  • code :
    • raw tag before each liquid sentence
    • inline : {% raw %} {% block %} {% endraw %}
    • indent code with two tabs
  • tables : raw html
  • Markdown:
    • the first md line must be right after :markdown, no empty line or error
  • images :
    • stored in samples/guides/ ...

documentation's People

Contributors

did avatar jloosfelt avatar jaredklewis avatar gabrielnau avatar youroff avatar dirklectisch avatar mariovisic avatar benjaminwood avatar yrb avatar jdlich avatar jadaw1n avatar estellelocomotivecms avatar maxim-filimonov avatar aaronrenner avatar hashnotadam avatar bmaland avatar ddeyoung avatar audionerd avatar fabienheureux avatar steve384 avatar joshrieken avatar lengarvey avatar lgrocket avatar lukeholder avatar marcelfahle avatar rvalyi avatar roadt avatar papipo avatar steveclarke avatar swolie 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.