This repo is the home of the unified Lottie docs hosted at http://airbnb.io/lottie. This repo is NOT the place to contribute to or report issues on any of the players or the After Effects plugin.
Contributing to the docs directly on GitHub (easy)
Because the Lottie docs are created directly from the markdown in this repo, you can use the GitHub web editor to edit and propose changes to the docs directly from your browser without any knowledge of git. To do that, find the markdown file with the docs you want to edit and follow GitHub's instructions to edit and propose changes to a markdown file. Once approved, the docs will be updated immediately.
Contributing to the docs by forking this repo (still pretty easy)
http://airbnb.io/lottie runs on docsify. Docsify was chosen because it takes hosted markdown and generates the page dynamically. That means that simply updating the markdown files here is all that is needed to update http://airbnb.io/lottie.
- Fork and clone this repo.
- Install docsify:
sudo npm install -g docsify-cli.
- Startup the local docsify server with
docsify serve .from the root of this repo.
- Edit the markdown and verify your changes on the localhost url outputted from the
- Put up a pull request to this repo and tag
- Enjoy the updated docs!