Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.

Latest commit

 

History

History
95 lines (64 loc) · 5.58 KB

README-template.md

File metadata and controls

95 lines (64 loc) · 5.58 KB
Raw

This is a sample theme for Obsidian (https://obsidian.md).

First Time publishing a theme?

Quick start

Pasted image 20220822135601

First, choose Use this template. That will create a copy of this repository (repo) under your Github profile. Then, you will want to clone your new repository to your computer.

Once you have the repo locally on your computer, there are a couple of placeholder fields you will need to fill in.

  1. Inside the manifest.json file, change the "name" field to whatever you want the name of your theme to be. For example:
{
  "name": "Moonstone",
  "version": "0.0.0",
  "minAppVersion": "1.0.0"
}
  1. Also inside the manifest.json file, you can include your name under next to the "author" field.

After you have those fields configured, all that's left to do is add your styles! All of your CSS needs to be inside the file theme.css which is located at root of your repository.

Adding your theme to the Theme Gallery

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.