Skip to content

lingo-app/developer-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

developer.lingoapp.com

This repo powers the development site for Lingo Developer Docs

Contribute!

We've made this repository public so you can contribute to it. If you find a typo, or an error, or want to improve the content, feel free to send us a pull request. Also, if there's anything you'd like to see covered or documented, file an issue and we'll do it for you.

We use Jekyll as our content backend, so make sure to read their docs if you need help understanding how the system works.

Setup

To build the site you will need:

On older versions of macOS (<10.15) you may need to install a newer version of Ruby, more details on that in this jekyll guide.

After that is setup run:

gem install --user-install bundler jekyll

Finally, to build and view, run:

yarn start

Deploying

The docs are automatically deployed by GitHub actions when merging into Master. To deploy manually run npm deploy