Skip to content

Gibbu/create-bd-theme

Repository files navigation

create-bd-theme

A CLI to scaffold BetterDiscord themes using SCSS.


Usage

Have NPM v5.2+ installed with NodeJS and then run the following command:

npx create-bd-theme MyTheme [options]

This will ask a series of questions such as: Theme name, Description, your GitHub name, and if you'd like it initalize a Git repository.


Make sure your GitHub name is correct as the CLI will use that for the GitHub Pages @import.
Providing the --git option will initialize a git repo and skip asking you.


Move into the newly created directory and install the dependency using:

cd MyTheme
npm install

Now you're able to access the dev and build scripts using:

npm run dev
# and
npm run build

The dev script will watch the file specified in the bd-scss.config.js dev option. If not provided it will default to src/dev.scss.
The build script will compile the dist and base options to generate the necessary files.

View bd-scss for more info.


Deployment

When you're ready to share your awesome theme, all you need to do is push the changes to your repository and enable GitHub pages to target the deploy branch.
GitHub actions will take care of the compiling of the SCSS.

About

A CLI to scaffold BetterDiscord themes using SCSS.

Topics

Resources

License

Stars

Watchers

Forks