GitHub sync (available only in preview mode)

The GitHub sync feature on Hashnode Docs lets you write content on GitHub in Markdown and MDX formats and turn it into beautiful, user-friendly documentation. It also helps you receive contributions to your documentation if you choose to keep it open-source.

Here’s how you can use the GitHub sync feature:

1. Go to the docs dashboard and scroll down to the GitHub option on the dashboard in the left sidebar.

   

2. Click on Install Hashnode app and it will redirect you to GitHub to install the Hashnode app.

   

3. Choose where you want to install the app. You will see multiple options if you are part of different organizations. Select the appropriate one.

4. Then choose the Only select repositories option and select the repository you want to use as a source for the docs.

   

5. Then click on Install & Authorize to finally install the app on the selected repository.

6. Once everything is done, you can add Markdown or MDX files on GitHub, which will be converted into user-friendly docs using the installed Hashnode app.