runwayml/learn

This is the public page to learn about how to use RunwayML. This includes technical references, the RunwayML API docs, tutorials and examples.

The site is online at http://learn.runwayml.com

Developing and running locally

This site is built with docsify.

To get started developing locally first install docsify-cli globally by running:

npm i docsify-cli -g

Then, clone this repository and then cd into the directory.

To start the dev server run:

docsify start ./docs

Now the documentation app will be running at http://localhost:4000

[SSR] Serving ./docs now.
Listening at http://localhost:4000

Check docsify's quick start guide if you have any issues with the development.

Structure

The source code is hosted inside the docs folder.

Every tutorial is named following the tutorial_[NAME_OF_TUTORIAL].md syntax. All other pages are listed individually.

There's one global style file.

Contributing

We are happy to receive any pull requests with changes that could make our documentation better and easier to understand.