The website sources about the new LocomotiveCMS documentation "center"
CSS JavaScript Ruby
Pull request Compare This branch is 128 commits behind locomotivecms:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
data
public
.gitignore
Gemfile
Gemfile.lock
Readme.md
TODO.md
VERSION
config.ru

Readme.md

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/ ...