📝 Scope Readme

You can add freeform content to be visible to all users with read or view access to your scope. The README will be displayed in the scope overview.

Navigate to your scope.
Create a component called readme using Cloud Workspaces.
Initialize a new Cloud Workspace for the scope by clicking the "Edit Scope" button.
Open the terminal and execute the following command to create a README-MDX component:

bit create mdx readme --env teambit.mdx/mdx-env
Copied

Edit the file named readme.mdx.
When you're satisfied with the scope description, select "Tag & Export."

Flexibility with React

While MDX is powered by React and allows embedding complex functionality beyond Markdown, you can also create a React component named README with a default export. Bit Cloud uses that default export to render content on the scope profile page.

For example, see this component

🦶 Next Steps

Customize scopes
Scope visibility
Scope permissions