Publish a theme
Write your theme and publish it on GitHub to share your wonderful theme with the community.
Example of a theme repository: cvwonder-theme-default.
Github repository
Create a new repository on GitHub with the name of your theme.
Why only GitHub is referenced? Please see the Hosting section.
Name
The repository name is usually prefixed with cvwonder-theme- to make it easy to find.
Your theme named my-wonderful would be hosted on repository named cvwonder-theme-my-wonderful.
Visibility
Your repository must be public to be shared with the community.
Topics
Add the following topics to your repository to make it easy to find:
cvwonder-theme
Theme metadata
Add a theme.yaml file at the root of the repository which contains the theme metadata.
name: My Wonderful
slug: my-wonderful
description: A wonderful theme for your CV
author: Germain
minimumVersion: 0.3.1
| Key | Description |
|---|---|
name | The name of the theme |
slug | The slug of the theme. It is used to name your directory in the themes/ folder. |
description | A short description of the theme |
author | The author of the theme |
minimumVersion | The minimum version of cvwonder required to use the theme. |
Publish theme
Push your changes to the GitHub repository.
git add .
git commit -m "Add theme"
git push origin main
The default theme cvwonder-theme-default is a good example to follow.
Hosting
For now, only GitHub is supported. This will probably change in the future.
If you want to use another hosting platform, please open an issue on the Github repository.