Can someone fix the documentation on how to create a new theme?

[joes]

Re: NodeBB broken after installing a theme!

Can someone fix the documentation on how to create a new theme?

There's no mention of the required plugin.json file!

No mention of how to create an NPM package, version it and install it.

No mention of how to debug it (eg ./nodebb dev or build..) if something goes wrong.
And there were no frontend error messages to tell me the build wasn't working - just no updates!!!!

I've just wasted an afternoon following the documentation to the letter and wondering why it doesn't work.

Not a great experience for someone new to nodebb.

I do think its an awesome project though (other than above).

Joe

[julian]

Hi @joes -- the easiest way to get started on a theme is to fork nodebb-theme-quickstart, as it has all of the base files created (and then all you need to do is replace quickstart with your own theme name as necessary).

I'll add a blurb into the theming docs about this.

[julian]

Added a new page here: https://docs.nodebb.org/development/

... and updated the theming docs to talk about quickstart theme.

[joes]

Hi Julian,

Thanks for that.
I did find the quickstart repo eventually.
Hope this helps others.
Cheers,
Joe