There is a concept of README.md file for each project. Tercen automatically converts this file into the "Front Page" of your project. Use the Markdown writing structure to quickly create high-quality documentation for the project.


No time to read?

Watch a video of how it's done. We have timestamped the section for you.

Tip: Open the video in another browser tab beside Tercen. That way, you can pause it and follow along with the instructions.


To create a README.md file for a project, perform the following:

  • Go to the project folder

  • Create a file using the New file button

  • Name the file `README.md`

  • Save it

Voila, you have an empty README.

You can edit it anytime using the edit button, the syntax for the markdown is the standard syntax. Currently, we support the following markdown syntax:

# Section

## Subsection

Here's a guide to markdown if you want to investigate more.
Getting started with Markdown

To embed a view of one of the workflow's data step, use the following syntax.

<div workflowId="4d2ce64e3312592700d1d36dabe7c404" stepId="de008572-2b81-4a4e-9681-cad765c675ab"></div>

Replace the hexadecimal numbers (e.g. 4d2ce64e3312592700d1d36dabe7c404) of the workflowId and stepId to the one which contains the data step you wish to connect with.

Did this answer your question?