pelagic-bootswatch
v1.0.0
Published
A Bootswatch theme derived from Flatly and the Pelagic colorscheme.
Downloads
143
Maintainers
Readme
Pelagic Bootswatch
Pelagic is a Bootstrap 5.3.8 theme derived from Bootswatch Flatly and remapped to the palette in colorscheme.md.
It ships compiled LTR/RTL CSS, minified CSS, and the SCSS source needed to rebuild or customize the theme.
Install
npm install pelagic-bootswatchCDN
Use jsDelivr with a pinned version in production:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/pelagic/bootstrap.min.css">For RTL:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/pelagic/bootstrap.rtl.min.css">The package also defines a jsDelivr default file, so this works:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]">Prefer the explicit file URL when documenting production usage.
Theme Modes
Pelagic supports Bootstrap's data-bs-theme color-mode API.
Set the whole page:
<html lang="en" data-bs-theme="dark">Or scope a mode to a component subtree:
<section data-bs-theme="light">
<div class="card">
<div class="card-body">Light themed component</div>
</div>
</section>Build
npm install
npm run build:allThe compiled CSS is written to dist/pelagic/.
Demo
Open demo.html in a browser to review the theme across navbars, buttons, forms, tables, alerts, cards, tabs, pagination, list groups, accordions, modals, toasts, and dark/light modes.
Open demo-rtl.html to review the generated RTL CSS with dir="rtl" across directional components.
Files
scss/pelagic/_variables.scss: Bootstrap variable overrides and the Pelagic color mapping.scss/pelagic/_bootswatch.scss: Flatly-derived component polish and light/dark mode support.scss/pelagic/bootstrap.scss: Theme entrypoint.dist/pelagic/bootstrap.css: Expanded compiled theme CSS.dist/pelagic/bootstrap.min.css: Minified compiled theme CSS.dist/pelagic/bootstrap.rtl.css: Expanded RTL compiled theme CSS.dist/pelagic/bootstrap.rtl.min.css: Minified RTL compiled theme CSS.
Publishing
Before publishing:
npm run release:checkPreview the publish step without uploading:
npm run publish:dry-runPublish to npm:
npm run release:publishIf npm asks for two-factor authentication, pass your current authenticator code:
npm run release:publish -- --otp=123456After npm publish completes, jsDelivr can serve the new version immediately from:
https://cdn.jsdelivr.net/npm/pelagic-bootswatch@VERSION/dist/pelagic/bootstrap.min.cssLicense
MIT
