Sprengnetter Bootstrap 5 Theme
Usage
This theme is a complete replacement for Bootstrap 5. You do not need to include
both, bootstrap.css
and sprengnetter-bootstrap-theme.css
. The latter is sufficient.
Copy the contents of a certain release to your designated asset folder or use NPM to install this theme as a dependency.
$ npm install sprengnetter-bootstrap-theme --save
If you like to use this theme in your own Sass code and installed this theme
with NPM you can import the source files to your manifest (e.g. index.scss
)
as well.
@import "sprengnetter-bootstrap-theme/src/styles/index.scss";
Development
Contribution is always welcome. Please use pull requests, if you want to incorporate changes or new components. For development purposes of this theme, we use the official Bootstrap documentation pages and apply the styles of this theme to it. Therefore this repository uses a submodule to link the official Bootstrap repository and a build script to generate and serve the documentation pages locally.
Setup
-
Install node v10 or higher
-
Clone project
git clone git@github.com:sprengnetter/sprengnetter-bootstrap-theme.git
-
Go into the project folder
cd sprengnetter-bootstrap-theme
-
Init the Bootstrap submodule
git submodule update --init
(only needed the very first time) -
Install Bootstap's documentation pages
npm run docs:install
-
Compile styles and serve documentation
npm start
Now you should see the Bootstrap documentation pages with sprengnetter styling applied.
npm start
incorporates a watcher, so you can write code and see your
changes immediately in the browser.