Submitting Nimvio Theme

What we will do:


This guide outlines the prerequisites and steps for submitting your theme to the Nimvio Theme Listing. If you've already followed the directions in the previous guide titled "Creating Nimvio Theme | Nimvio Guide," your theme is nearly prepared for inclusion in the listing.

The initial prerequisite for submitting your theme is ensuring that you possess, at the very least, the necessary theme assets and a frontend repository before initiating the submission process. Once you've verified the presence of these essential theme resources, it is crucial to conduct comprehensive testing of the theme, including its content.

Upon successfully completing the aforementioned tasks, the last essential step before submitting your theme is to create proper documentation.

Step 1: Theme Resource Preparation

During this step, your primary objective is to assemble the essential resources required for your theme to function correctly. Typically, this entails having a prepared content template, content, and media assets that your theme can utilize. As a general guideline, your theme resources should encompass the following components:

  1. Pre-defined content templates
  2. Pre-populated content
  3. Media assets

In the process of preparing these theme resources, it is crucial to consider how you structure your content effectively. You may refer to our guide titled "Structuring Reusable and Scalable Content | Nimvio Guide" as a starting point for understanding content structuring.

If, for instance, you like the Nimvio's "Royal Blue On White" theme and want to extend the functionality further, rather than creating the project from scratch, you have the option to initiate a new project using this preferred theme as a foundation. Later during theme submission, you can choose the generated project as the source project for your new theme.

Step 2: Repository Preparation

The next step in the preparation process involves establishing a functional code repository that will make use of the theme resources you've gathered in the previous step. Take a look at the following repository, which has made specific styling modifications to the Nimvio Royal Blue on White theme: Link to the repository.

Here are a couple of important points to keep in mind:

  1. Your repository should be publicly accessible on GitHub.
  2. Public themes are required to have an open-source license.
  3. Documentation contain information about how to run the theme locally and on CI/CD server

Step 3: Website Preview Preparation

To ensure that your theme provides the optimal experience for end-users, it's essential to configure it correctly using the Nimvio Website Preview editor. Prior to proceeding to the next step, please refer to the guide titled "Working with Live Preview | Nimvio Guide" for instructions on how to do this.

Step 4: Theme Testing

This phase is a crucial aspect of theme testing, and it's imperative that you conduct a comprehensive examination of your theme prior to submission. It's advisable to commence testing your theme locally. If your intention is to build upon the Nimvio Royal Blue on White theme, you'll typically need to make adjustments to the environment variables, as outlined here: Link to the relevant section.

Step 5: Submit theme to Nimvio

We are now prepared to submit the theme to Nimvio:

  1. Navigate to the project listing page and select the "Themes" tab.
  2. Click on the "Submit Theme" button.
  3. Complete the form by providing the necessary details, including the theme name, the project to serve as the theme source, the repository link, the link to the demo website, and a screenshot of the theme.
  4. Your new theme will be displayed on the theme listing page.


What's Next?

Congratulations! You have finished this part of the guide. Keep exploring below: