https://github.com/nodebb/nodebb-theme-quickstart
Quickstart Theming Shell
https://github.com/nodebb/nodebb-theme-quickstart
Last synced: 9 months ago
JSON representation
Quickstart Theming Shell
- Host: GitHub
- URL: https://github.com/nodebb/nodebb-theme-quickstart
- Owner: NodeBB
- Created: 2014-03-30T19:41:55.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T18:11:25.000Z (12 months ago)
- Last Synced: 2025-03-28T21:02:28.319Z (9 months ago)
- Language: JavaScript
- Size: 124 KB
- Stars: 25
- Watchers: 8
- Forks: 156
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quickstart Theme for NodeBB
This repository contains all of the preparatory work for a theme based off of the [Harmony theme](https://github.com/NodeBB/nodebb-theme-harmony). If you'd like to base your theme off another supported theme instead, switch to the appropriate branch:
* [Lavender](https://github.com/NodeBB/nodebb-theme-lavender)
Fork it to create your own theme based off of it!
### Some things to change
* You should rename this theme from `quickstart` to something else. Change all instances of that word in the following files:
* `package.json`
* `plugin.json`
* `theme.json`
### When you're done...
Be sure to add some other metadata to the `package.json`, like this:
``` json
"author": {
"name": "Your Name",
"email": "Your Email",
"url": "Your website"
},
"repository": {
"type": "git",
"url": "https://github.com/{your-username}/{your-repository}"
},
"bugs": {
"url": "https://github.com/{your-username}/{your-repository}/issues"
}
```
Also, add a screenshot! Take a picture of your theme, and save it as "screenshot.png" in the root of your theme folder, then add this to `theme.json`:
``` json
"screenshot": "screenshot.png"
```
### Credits
Material theme by [pichalite](https://github.com/pichalite).