Skip to content

EndlessReform/obsidian-nord-muted

Repository files navigation

Obsidian Nord Muted Theme

Example screen

A simple port of the Nord editor theme to Obsidian. Compared to the existing Obsidian Nord theme, this theme is a bit quieter, darker, and less opinionated.

⚠️ Warning

  • Not tested on mobile!
  • Not tested on Obsidian Publish!
  • Not in the Theme Gallery!

Feel free to make a request in a GH Issue if you want support.

Installation

  1. Go to Settings -> Appearance, and find the Themes folder. The path should look something like $YOUR_VAULT_FOLDER/.obsidian/themes.

Theme folder location

  1. From your terminal, open the theme folder and clone this repo. Do NOT change the folder name.
  2. Back in the Obsidian Settings -> Appearance -> Themes, select nord_muted.
  3. Change your Accent color to one of the Nord colors. Choose from the Frost or the Aurora palettes.

If these steps are too technical or annoying, please make a request in GH Issues and I'll try adding this to the Theme Gallery.

Adding your theme to the Theme Gallery (for maintainers)

Add a screenshot thumbnail

Inside the repository, include a screenshot thumbnail of your theme. You can name the file anything, for example screenshot.png. This image will be used for the small preview in the theme list.

Your screenshot file should be 16:9 aspect ratio. The recommended size is 512x288.

Submit your theme for review

To have your theme included in the Theme Gallery, you will need to submit a Pull Request to obsidianmd/obsidian-releases.

Releasing Versions (Optional)

If your theme is getting more and more complex, you might want to start thinking about how your theme will stay compatible with different versions of Obsidian. Introduced in v0.16 of Obsidian, themes support Github Releases. This means that you can specify which versions of your theme are compatible with which versions of Obsidian.

Steps for releasing the initial version of your theme (1.0.0)

  1. From your theme's repository, click on "Releases".

Pasted image 20220822145001

  1. On the Releases page, there should be a button to Draft a new Release. Press it.

Pasted image 20220822145048

  1. Fill out the Release information form.
    • Choose a Tag: Type in the name of the version number here. At the bottom of the dropdown should be a button to create a new tag with your latest theme changes. Choose this option. Pasted image 20220822145648
    • Release Title: This can be the version number.
    • Description Optional: Anything that changed
    • Files: The most important part of this form is uploading the files. You can do this by dragging 'n dropping the manifest.json file and the theme.css file your for theme inside the file upload field.

Pasted image 20220822145356

  1. Click "Publish Release."
  2. Make sure that versions.json is set up correctly. This file is a map.
{
	"1.0.0": "0.16.0"
}

This means that version 1.0.0 of your theme is compatible with version 0.16.0 of Obsidian. For the initial release of your theme, you shouldn't need to make any changes to this file.

Steps for releasing new versions

Releasing a new version of your theme is the same as releasing the initial version.

  1. From your theme's repository, click on "Releases."

  2. On the Releases page, there should be a button to Draft a new Release. Press it.

  3. Fill out the Release information form.

    • Choose a Tag: Type in the name of the version number here. At the bottom of the dropdown should be a button to create a new tag with your latest theme changes. Choose this option. Pasted image 20220822145812
    • Release Title: This can be the version number.
    • Description Optional: Anything that changed
    • Files: The most important part of this form is uploading the files. You can do this by dragging 'n dropping the manifest.json file and the theme.css file your for theme inside the file upload field.
  4. Click "Publish Release."

  5. Update the versions.json file in your repository. For the initial release of your theme, you probably didn't need to make any changes to the versions.json file. When you release subsequent versions of your theme; however, it's best practice to include the new version as entry in the versions.json file. So this might look like:

{
	"1.0.0": "0.16.0",
	"1.0.1": "0.16.0"
}

What's important to note here is: the new version is included as the "key" and the "value" is the minimum version of Obsidian that your theme compatible with. So if the new version of your theme is only compatible with an Insider version of Obsidian, it's important to set this value accordingly. This will prevent users on older versions of Obsidian from updating to the newer version of your theme.

About

A minimal Nord theme for Obsidian

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published