Comment
Adds a markdown-formatted comment to the graph.
Inputs#
| Port | Description |
|---|---|
| The markdown-formatted text to display in the comment box. |
Addendum#
The Comment node allows you to add rich-text documentation directly to your graph. It is useful for explaining complex sections, leaving notes for collaborators, or outlining the graph's logic.
The comment text supports a subset of Markdown for formatting.
Supported Markdown#
| Feature | Syntax | Example |
|---|---|---|
| Headings | # H1, ## H2 |
## Section Title |
| Bold | **text** |
This is important |
| Italic | *text* |
This is a note |
| Strikethrough | ~~text~~ |
~~Obsolete part~~ |
| Link | [Text](URL) |
[Visit Docs](https://docs.actionforge.dev) |
| Inline Code | `code` |
Use the getValue() function. |
| Code Block | ``` [lang]... ``` |
See example below. |
Example#
Here is an example demonstrating various formatting options:
# Graph: Asset Processing
This graph processes texture files from the input directory.
## Steps
1. **Load** textures using the `read_file` node.
2. **Resize** to `1024x1024`.
3. **Convert** to `.ktx` format.
## Important Note
The resizing step uses *bicubic filtering* for best quality. For more details, see the [internal wiki](https://wiki.example.com/AssetProcessing).
```python
# This is a Python example
def convert_to_ktx(image_path):
print(f"Converting {image_path}...")
ID: core/comment@v1