Made with Hope

🎭 Customize Organization Profile

The organization profile page showcases information about your company or open-source project. You can customize it to fit your needs.

Personalize the organization profile:

Here's how to personalize the organization profile:

You must be an organization administrator to access these features.
  1. Go to your organization page and select the Settings tab.
  2. You'll find several options to customize your profile:
  • Display Name: This acts as a "pretty name" displayed alongside the organization's account name.
  • Description: Use this freeform text field to introduce the organization.
  • Avatar: Upload an image relevant to the Bit Cloud account, such as your company logo.

Adding an organization README

You can add freeform content to be publicly visible to all users and members of the organization. The README will be displayed on the organization's dashboard.

  1. Create a public Scope named general.
  2. Create a component called account-readme using Cloud Workspaces.
  3. Initialize a new Cloud Workspace for the scope by clicking the "Edit Scope" button.
  4. Open the terminal and execute the following command to create a README-MDX component:
bit create mdx account-readme --env teambit.mdx/mdx-env
CopiedCopy
  1. Edit the file named account-readme.mdx.
  2. When you're satisfied with your organization's description, select "Tag & Export."
Flexibility with React

While MDX is driven 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 organization profile page.

For example, see this organization.



🦶 Next Steps