Skip to content
Cortex

Publishing and Review

Prepare theme release assets for review and community listing.

2 min readEdit on GitHub

Reviewed community listing installs theme assets into the active vault.

Release a Version#

bash
cortex checkcortex release patch   # or minor, major

cortex release runs the checks, bumps version in manifest.json and package.json, commits, tags v<version>, and pushes. The release workflow scaffolded by cortex create then runs cortex pack and publishes the GitHub release with the manifest and both stylesheets.

Versions are plain MAJOR.MINOR.PATCH; pre-release suffixes break update checks.

List in the Marketplace#

bash
cortex submit

cortex submit verifies the latest GitHub release, then opens a pull request to the Marketplace registry. Run it only for the first release and when the name, description, author, or cover image change. Every later release reaches users automatically.

Required Release Assets#

Publish:

text
manifest.json
light.css
dark.css

The CSS filenames can differ when the manifest references different safe relative paths.

For each colorscheme, Cortex looks for:

  1. The exact relative path from manifest.colorschemes.
  2. The basename of that path.
  3. <colorscheme>.css, such as light.css or dark.css.

Manifest checks#

The reviewed listing flow verifies:

  • manifest.json is valid JSON.
  • manifest.id matches the listing entry id.
  • manifest.name equals manifest.id.
  • colorschemes.light and colorschemes.dark are safe relative paths.
  • Both stylesheet assets exist before replacing an installed theme.

Install and rollback behavior#

Cortex installs into:

text
<vault>/.cortex/themes/<theme-id>

Theme install and update use staging inside the vault themes directory. Cortex preserves the previous installation until staging is promoted and community themes reload successfully. On failure, it removes staging and restores the previous theme best effort.

Votes, Downloads, and Review#

Once listed, the Marketplace and the website show community signals for your theme, published by the registry's GitHub Actions:

  • Votes are upvotes on the theme's Discussion in cortex-md/registry. "Vote on GitHub" in Cortex and on the website opens it; counts refresh every 30 minutes.
  • Downloads add up the stylesheet downloads of every GitHub release, including updates.
  • Automated review scans the latest release every day with the same static rules as cortex check. A failing release opens an issue and a proposed block for a maintainer to decide.
  • Verified items are hand-picked by maintainers. Pulled versions stop being offered as installs or updates; installed copies are never removed automatically.

Run cortex stats to see all of this for your project. cortex submit also checks that you own the repository, or are a public member of its organization, before opening the registry pull request.

Release checklist#

  1. Run cortex check and fix every error.
  2. Include manifest.json.
  3. Include both light and dark CSS assets.
  4. Keep stylesheet paths relative and free of ...
  5. Test applying the theme from light, dark, and system appearance modes.
  6. Test uninstall while the theme is active.

Search docs

Search Cortex documentation pages and headings.