ContextQMD
Back to Notesnook

Publish a new theme

docs/help/contents/custom-themes/publish-a-theme.md

3.4.10-android3.8 KB
Original Source

Publish a new theme

What you need

  1. A GitHub account
  2. JSON file containing your theme (you can export the JSON file using the Theme Builder)

Publish your theme

  1. Go to https://github.com/streetwriters/notesnook-themes and "Fork" the repo. (Don't forget to "Star" it as well!)
  2. Click the "Create fork" button on the next page.
  3. Once your fork has been created, go to the themes/ directory and create a new file.
  4. Enter the path for your file as {your-theme-id}/v1/theme.json. (Pressing / will create a new directory.)
  5. Paste the contents of the JSON theme file and click "Commit changes".
  6. Enter title of your commit as "add {your-theme-id} theme"
  7. Click "Commit changes"
  8. On the next page, click "Contribute" and then click "Open pull request" from the popup.
  9. Click "Create pull request"
  10. Click "Create pull request"
  11. And you are all done!

Update a published theme

Once your theme is published, you will probably need to push a new update for your theme to fix a color or change something. You can do this by selecting your theme as the starter theme in the Theme Builder and making the changes. Once everything is ready, export the changed theme as usual.

::: warning Don't forget to increment the version of your theme; otherwise, no one will be able to see the changes.

:::

To publish the updated theme, you will need to submit a new pull request in the same way as you did while publishing:

  1. Go to your fork on GitHub.
  2. Click "Sync fork" and then click the "Update branch" button.
  3. Go to themes/your-theme-id/v1 directory and open the theme.json file.
  4. Click the Edit button
  5. Paste your updated theme and click "Commit changes".
  6. Enter title of your commit as update {your-theme-id} theme and click "Commit changes".
  7. Now go to the homepage of your fork and click "Contribute" and then click "Open pull request" in the popup.
  8. Click "Create pull request"
  9. You are all done!