https://github.com/gibbu/create-bd-theme
A CLI to scaffold BetterDiscord themes using SCSS.
https://github.com/gibbu/create-bd-theme
betterdiscord cli scss template
Last synced: about 1 year ago
JSON representation
A CLI to scaffold BetterDiscord themes using SCSS.
- Host: GitHub
- URL: https://github.com/gibbu/create-bd-theme
- Owner: Gibbu
- License: mit
- Created: 2022-01-31T08:01:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T11:37:39.000Z (over 1 year ago)
- Last Synced: 2025-04-14T22:53:36.830Z (about 1 year ago)
- Topics: betterdiscord, cli, scss, template
- Language: JavaScript
- Homepage:
- Size: 67.4 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-bd-theme
A CLI to scaffold BetterDiscord themes using SCSS.
## Usage
Have [NPM](https://nodejs.org/en/) v5.2+ installed with NodeJS and then run the following command:
```bash
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:
```bash
cd MyTheme
npm install
```
Now you're able to access the `dev` and `build` scripts using:
```bash
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](https://github.com/Gibbu/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.