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.
_docs
_includes
_layouts
_reference
bin
css/font-awesome
img
js
.gitignore
CNAME
Gemfile
LICENSE
README.md
_config.yml
articles.md
docs.md
index.html
quick-start.md
reference.md
style.css

README.md

Ufo Documentation

This project powers the ufo documementation website: ufoships.com. It is a static website generated by Jekyll.

Contributing

For minor changes like typos, you can click Suggest an edit to this page, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.

Local Setup

For larger fixes, you can run the site locally with the following:

git clone https://github.com/tongueroo/ufo.git
cd ufo/docs
bundle
bin/web # runs jekyll clean and jekyll serve

You'll be able to view the site on http://localhost:4000.