Skip to content

Commit 89ef3cc

Browse files
committed
Simplify docs language and rename reference to Syntax
1 parent 040741b commit 89ef3cc

11 files changed

Lines changed: 28 additions & 27 deletions

File tree

‎.vitepress/config.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export default defineConfig({
2525
]
2626
},
2727
{
28-
text: 'YAML Reference',
28+
text: 'Syntax',
2929
items: [
3030
{ text: 'Overview', link: '/reference/' },
3131
{ text: 'Folders', link: '/reference/folders' },

‎examples/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Examples
22

3-
Ready-to-use YAML recipes for common motion graphics patterns.
3+
Ready-to-use syntax recipes for common motion graphics patterns.
44

55
## Available examples
66

@@ -18,7 +18,7 @@ Creating .mogrt-ready templates with Essential Graphics.
1818

1919
## How to use
2020

21-
1. Copy the YAML from any example
21+
1. Copy the example text from any recipe
2222
2. Paste it into the Compdown panel
2323
3. Click **Create**
2424
4. Modify as needed

‎examples/motion-templates.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Motion Graphics Templates are After Effects compositions with exposed properties
99
Compdown lets you:
1010
1. Define compositions with editable properties
1111
2. Expose those properties via Essential Graphics
12-
3. Export back to YAML preserving the property mappings
12+
3. Export back to Compdown text preserving the property mappings
1313

1414
## Basic template
1515

@@ -286,9 +286,9 @@ essentialGraphics:
286286
```
287287
288288
### Test round-trip
289-
1. Create the template from YAML
289+
1. Create the template from Compdown text
290290
2. Modify values in AE
291-
3. Export back to YAML
291+
3. Export back to text
292292
4. Verify the properties are preserved
293293
294294
## Exporting as .mogrt

‎guide/index.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Introduction
22

3-
Compdown is an After Effects extension that lets you describe compositions, layers, and animations in YAML — then create them with a single click.
3+
Compdown is an After Effects extension that lets you describe compositions, layers, and animations in text — then create them with a single click.
44

55
## What is Compdown?
66

7-
Instead of clicking through menus or writing ExtendScript, you write human-readable YAML:
7+
Instead of clicking through menus or writing ExtendScript, you write readable Compdown syntax:
88

99
```yaml
1010
compositions:
@@ -25,13 +25,13 @@ Click a button, and Compdown creates the composition with all layers, properties
2525
## Why text-based workflows?
2626
2727
### Readable
28-
YAML is designed for humans. You can read a Compdown file and understand what it creates without running it.
28+
Compdown syntax is designed to be human-friendly. You can read a file and understand what it creates without running it.
2929
3030
### Shareable
3131
A Compdown file is just text. Email it, paste it in Slack, commit it to git, or share it in a gist. No binary files, no version compatibility issues.
3232
3333
### Fast
34-
Building variations? Copy the YAML, change a few values, paste it back. No need to duplicate comps or dig through the project panel.
34+
Building variations? Copy the text, change a few values, paste it back. No need to duplicate comps or dig through the project panel.
3535
3636
### AI-friendly
3737
Text in, text out. AI tools can read, modify, and generate Compdown files just like any other code. This opens up workflows where AI helps draft scenes, explore variations, or build first passes.
@@ -49,7 +49,7 @@ Text in, text out. AI tools can read, modify, and generate Compdown files just l
4949

5050
## Two-way workflow
5151

52-
Compdown isn't just for creation. You can also **export existing compositions** back to YAML. This enables:
52+
Compdown isn't just for creation. You can also **export existing compositions** back to text syntax. This enables:
5353

5454
- Documenting what a comp contains
5555
- Version controlling motion design

‎guide/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This starts a dev server at `localhost:3000`. Changes to the panel code will hot
5050

5151
1. Open After Effects
5252
2. Go to **Window > Extensions > Compdown**
53-
3. You should see the Compdown panel with a YAML editor
53+
3. You should see the Compdown panel with a text editor
5454

5555
If the panel doesn't appear, check:
5656
- Debug mode is enabled (for local builds)

‎guide/quick-start.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Quick Start
22

3-
Let's create your first composition with Compdown. By the end of this guide, you'll understand the basic YAML structure and how to build animated layers.
3+
Let's create your first composition with Compdown. By the end of this guide, you'll understand the basic structure and how to build animated layers.
44

55
## Your first composition
66

7-
Open the Compdown panel in After Effects and paste this YAML:
7+
Open the Compdown panel in After Effects and paste this:
88

99
```yaml
1010
compositions:
@@ -27,7 +27,7 @@ Click the **Create** button. Compdown will:
2727
2. Add a text layer with "Hello World" centered in the frame
2828
3. Add a dark solid layer called "background" behind it
2929
30-
That's it. You've created your first composition from YAML.
30+
That's it. You've created your first composition from text syntax.
3131
3232
## Understanding the structure
3333
@@ -153,7 +153,7 @@ Compdown works both ways. To export an existing composition:
153153

154154
1. Select a composition in After Effects
155155
2. Click the **Export** button in Compdown
156-
3. The YAML representation appears in the editor
156+
3. The composition appears as text syntax in the editor
157157

158158
This is useful for:
159159
- Understanding what properties a comp has
@@ -164,5 +164,5 @@ This is useful for:
164164

165165
You now know the basics. Explore further:
166166

167-
- [Reference](/reference/) — Complete YAML schema documentation
167+
- [Reference](/reference/) — Complete syntax documentation
168168
- [Examples](/examples/) — Real-world recipes and patterns

‎index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: home
44
hero:
55
name: Compdown
66
text: A natural language for After Effects
7-
tagline: Describe compositions in YAML, create them with a click
7+
tagline: Describe compositions in plain text, create them with a click
88
actions:
99
- theme: brand
1010
text: Get Started

‎reference/compositions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ compositions:
6868
See [Layers](/reference/layers) for complete layer documentation.
6969

7070
::: tip Layer stack order
71-
Layer order in YAML maps to the AE stack with the first layer on top. Put background layers later in the list so they render behind foreground layers.
71+
Layer order in Compdown syntax maps to the AE stack with the first layer on top. Put background layers later in the list so they render behind foreground layers.
7272
:::
7373

7474
## Composition nesting

‎reference/effects.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ effects:
4040
The `matchName` is AE's internal identifier that stays consistent regardless of UI language.
4141

4242
::: tip Finding matchNames
43-
You can find effect matchNames in the [After Effects Scripting Guide](https://ae-scripting.docsforadobe.dev/) or by examining exported YAML from Compdown.
43+
You can find effect matchNames in the [After Effects Scripting Guide](https://ae-scripting.docsforadobe.dev/) or by examining exported Compdown text.
4444
:::
4545

4646
## Property value types

‎reference/essential-graphics.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ By default, Compdown encodes the property path in the controller name:
9999
Display Name [path:layer.transform.position]
100100
```
101101

102-
This allows exported YAML to include the full property path, enabling workflows like:
102+
This allows exported text to include the full property path, enabling workflows like:
103103

104-
1. Create comp from YAML with Essential Graphics
104+
1. Create comp from Compdown text with Essential Graphics
105105
2. Modify in Premiere
106-
3. Export back to YAML with paths preserved
106+
3. Export back to text with paths preserved
107107

108108
### Disabling path encoding
109109

0 commit comments

Comments
 (0)