Skip to main content

Add Markdown cells to your Astro Cloud IDE pipeline

Use Markdown cells to add comments to your code and make it easier for Workspace users to collaborate on shared code. The content of a Markdown cell appears as rendered Markdown in your pipeline editor, as well as a top-level comment in your pipeline DAG. It does not appear in the Airflow UI and is not related to the features described in Create DAG documentation in Apache Airflow.


Create pipeline documentation

  1. In the Astro UI, select a Workspace and then select Cloud IDE.

  2. Select a project.

  3. On the Pipelines page click a pipeline name to open the pipeline editor.

  4. Click Add Cell > Markdown.

  5. In the body of the cell, write your documentation in Markdown format.

  6. Click out of the cell to save your changes and view the rendered Markdown in your pipeline editor. To view your cell as raw Markdown in your DAG, click Code.

Rendered Markdown cell in the Cloud IDE

Was this page helpful?

Sign up for Developer Updates

Get a summary of new Astro features once a month.

You can unsubscribe at any time.
By proceeding you agree to our Privacy Policy, our Website Terms and to receive emails from Astronomer.