Elasticnote’s GitHub Sync capability allows users to seamlessly integrate their workspace with GitHub private or public repositories, enabling a smooth workflow between note-taking and version-controlled development projects.
GitHub Sync is available only for Elasticnote cloud workspaces. If you connect your workspace to a local directory, it cannot be synced with GitHub.
To set up a sync, select a workspace and click Manage > GitHub Sync. In the dialog that appears, enter your GitHub username, repository name, and personal access token.
Be sure to enable read and write access to repository contents for the token.
You will need to generate a GitHub fine-grained personal access token. Here is the official GitHub documentation on how to create one.
For example, for the repository notes under the username gituser, first log in to GitHub and navigate to Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate new token.
You must assign the necessary permissions for the sync:
Contents (Read & Write): to allow file access and updates
Metadata (Read-only): to access repository details
Finally, configure the token in Elasticnote by creating a new workspace associated with the notes repository.
In Elsaticnote, navigate to Workspace > Manage → GitHub Sync, paste the token in the designated field, along with your user and repository name, and click connect, if successful- close the dialog box.
You will see the connection button changed to Connected and it will show that GitHub repository successfully connected.
Elasticnote can now push changes from the workspace to GitHub, ensuring your cloud notes are always up to date. You retain ownership of the notes while leveraging GitHub’s version control for security and collaboration.
To disconnect the workspace from the Github synchronization, you can navigate again to Manage → GitHub Sync and click Disconnect. If your token is expired, you will need to reconnect your workspace. You can setup a long expiry token to avoid this.