Giter Site home page Giter Site logo

Comments (6)

Ross-Esmond avatar Ross-Esmond commented on May 18, 2024

I can help with these, by the way. That's a little bit iffy because I don't know motion canvas that well, but if you think of any to split off, I can write them. Realistically there should be dozens of pages to this, which can take a while to get to.

Documentation is probably one of the most important things to success. MC could launch in it's current state and be fine, but the docs would hurt it. It seems like I'm preaching to the choir though if you're willing to customize your typedoc plugin.

from motion-canvas.

aarthificial avatar aarthificial commented on May 18, 2024

Thanks for the offer!

I made this task before switching to docusaurus. Currently, no typedoc plugin is necessary because the guides are created using the docusaurus' docs plugin (example)

Here's my raw idea of what the Guides navbar should look like. If you want to create a page for any of these you're more than welcome to do so:

  • Introduction - Description of what Motion Canvas is, what are our goals etc. (least important)
  • Quickstart - I really like Manim's Quickstart section:
    • Scaffold a project
    • Animate something - Simply show the entire animation code with some comments
    • How to render it
    • Explanation - Line by line how the animation actually works. Link to more detailed documentation regarding each fragment.
  • Tutorials (Each is a separate page)
    • Animating components - Using .property(value, time) and .property(ANIMATE)
    • Controlling the flow of animation - No threading here. Only all, any, etc. always used with yield*)
    • Using time events - Meta files, using the UI, holding SHIFT (very important to mention)
    • Creating transitions
  • Advanced topics (Also separate pages)
    • Understanding threading - yielding entire generators, join. cancel etc.
    • Creating custom components - Here we may want to wait for the next renderer. Idk if there's a point in writing this for Konva.
    • Accessing the canvas context

I created this structure off the top of my head so I'm open to suggestions of course

from motion-canvas.

Ross-Esmond avatar Ross-Esmond commented on May 18, 2024

Alright. I'll start churning through some so that there are some guides to point to.

from motion-canvas.

Ross-Esmond avatar Ross-Esmond commented on May 18, 2024

For logging purposes, I still need to write "How to render it."

from motion-canvas.

aarthificial avatar aarthificial commented on May 18, 2024

Closing because the guides section is mostly finished:
https://motion-canvas.github.io/docs/category/getting-started

from motion-canvas.

Jeff0502 avatar Jeff0502 commented on May 18, 2024

Hey!

Thank you for this excellent project.

I am starting off with Motion Canvas, and as I attempt to create my projects, I really struggle to find basic examples of how to create animations.

For example:
I would like to animate basic 'flow-in' text. To achieve this, I googled "how to add text to motion canvas project", but I did not find much, except the API documentation. The API docs are great for experienced users, but unfortunately, since certain components inherit from multiple other components it can become tricky to navigate the API docs.

Why am I writing this?
It would be great if I could help to contribute to the project by writing basic examples on the documentation, such as "How to add text to Motion Canvas" or "How to fill the background" - maybe these basic examples can even be combined to something like 'How to create x animation from scratch start to finish'. As a programmer I usually boil things to specifics when I use Google, so I would love to help other people quickly discover how to use this project.

from motion-canvas.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.