https://github.com/lottiefiles/lottie-docs

Documentation for the lottie file format
https://github.com/lottiefiles/lottie-docs

documentation lottie lottie-animation lottie-web schema

Last synced: 5 months ago
JSON representation

Documentation for the lottie file format

• Host: GitHub
• URL: https://github.com/lottiefiles/lottie-docs
• Owner: LottieFiles
• License: cc-by-4.0
• Created: 2021-10-18T05:20:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-17T07:03:29.000Z (6 months ago)
• Last Synced: 2025-05-16T09:03:26.232Z (5 months ago)
• Topics: documentation, lottie, lottie-animation, lottie-web, schema
• Language: Python
• Homepage: https://lottiefiles.github.io/lottie-docs/
• Size: 2.87 MB
• Stars: 49
• Watchers: 12
• Forks: 195
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

README

          
Lottie Documentation

====================

This repository contains both human-readable and machine-readable documentation about the Lottie format

The documentation is available online at https://lottiefiles.github.io/lottie-docs/

License

-------

CC-BY 4.0

Setting Up

----------

This project uses `mkdocs` to generate the HTML pages from the documentation,

and `pip` to install dependencies.

It's recommended you install dependencies on some kind of virtual environment.

Once you have your environment, you can run

    pip install requirements.txt

or

    make install_dependencies

Building the Docs

-----------------

You can use

    make

To build the static HTML.

During development, you might want to use

    make docs_serve

Which spins up a local server to host the docs and automatically reloads when done

Finding Unknown Features

------------------------

You can run `./tools/unknown_features.js` and pass file names as arguments

and it will print a summary of unknown features in the given files.

Note that it requires modern versions of node and the compiled schema.

Example with setup:

    # Build the schema

    make lottie.schema.json

    # Install newer node on python virtualenv

    pip install nodeenv

    nodeenv -p

    # Run on several files

    ./tools/unknown_features.js /my/lotties/*.json