https://github.com/runwayml/learn
👩🏫 Learn how to use RunwayML with tutorials, guides, and examples!
https://github.com/runwayml/learn
docs documentation guidelines machine-learning runway runway-docs
Last synced: 7 months ago
JSON representation
👩🏫 Learn how to use RunwayML with tutorials, guides, and examples!
- Host: GitHub
- URL: https://github.com/runwayml/learn
- Owner: runwayml
- License: mit
- Created: 2018-10-24T00:16:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T03:02:02.000Z (almost 3 years ago)
- Last Synced: 2025-01-12T05:11:37.813Z (over 1 year ago)
- Topics: docs, documentation, guidelines, machine-learning, runway, runway-docs
- Homepage: https://learn.runwayml.com/
- Size: 194 MB
- Stars: 137
- Watchers: 28
- Forks: 28
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://runwayml.com/joinslack)
This is the public page to learn about how to use [RunwayML](https://runwayml.com/). This includes technical references, the RunwayML API docs, tutorials and examples.
The site is online at [http://learn.runwayml.com](http://learn.runwayml.com)
## Developing and running locally
This site is built with [docsify](https://docsify.js.org/#/).
To get started developing locally first install `docsify-cli` globally by running:
```bash
npm i docsify-cli -g
```
Then, clone this repository and then `cd` into the directory.
To start the dev server run:
```bash
docsify start ./docs
```
Now the documentation app will be running at [http://localhost:4000](http://localhost:4000)
```bash
[SSR] Serving ./docs now.
Listening at http://localhost:4000
```
Check [docsify's quick start guide](https://docsify.js.org/#/quickstart) if you have any issues with the development.
## Structure
The source code is hosted inside the [`docs`](https://github.com/runwayml/docs/tree/master/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`](https://github.com/runwayml/docs/blob/master/docs/assets/css/style.css) file.
## Contributing
We are happy to receive any pull requests with changes that could make our documentation better and easier to understand.