{"id":16594360,"url":"https://github.com/simonpadbury/b5st","last_synced_at":"2025-05-06T20:12:55.047Z","repository":{"id":48723048,"uuid":"361122919","full_name":"SimonPadbury/b5st","owner":"SimonPadbury","description":"WordPress starter theme with Bootstrap 5 and Bootstrap Icons","archived":false,"fork":false,"pushed_at":"2024-06-07T06:05:38.000Z","size":225,"stargazers_count":51,"open_issues_count":1,"forks_count":21,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-31T02:34:05.437Z","etag":null,"topics":["bootstrap5","sass","wordpress","wordpress-theme"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SimonPadbury.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-24T09:37:11.000Z","updated_at":"2025-03-23T14:21:21.000Z","dependencies_parsed_at":"2024-06-07T06:50:25.483Z","dependency_job_id":"82107bdc-441c-4c80-9a9c-d9a833b1dcb5","html_url":"https://github.com/SimonPadbury/b5st","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fb5st","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fb5st/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fb5st/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimonPadbury%2Fb5st/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimonPadbury","download_url":"https://codeload.github.com/SimonPadbury/b5st/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252761236,"owners_count":21800127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap5","sass","wordpress","wordpress-theme"],"created_at":"2024-10-11T23:46:03.367Z","updated_at":"2025-05-06T20:12:54.976Z","avatar_url":"https://github.com/SimonPadbury.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# b5st – A Bootstrap 5 Starter Theme, for WordPress\n\n*Version 1.3.3*\n\n[https://github.com/SimonPadbury/b5st](https://github.com/SimonPadbury/b5st)\n\n------------------\n\n\u003e b5st is a simple, Gutenberg-compatible WordPress starter theme loaded with Bootstrap 5 and Bootstrap Icons — using node-sass for preprocessing its SCSS into CSS.\n\n## Basic features\n\n* [UNLICENCE](http://unlicense.org) (open source).\n\n* Simple, intuitive, clean code. Theme CSS and JS, functions and loops are organized into different folders.\n\n* A starter CSS theme – `/theme/css/b5st.css`, enqueued. (Note: do not put your styles in `styles.css`, because that is not enqueued.)\n\n* `b5st.css` is generated from SCSS using `node-sass`. The SCSS files are also included.\n\n* A starter JS script – `theme/css/b5st.js` – unrequired but present as a starter (and with a commented-out enqueue).\n\n* Dimox breadcrumbs ([http://dimox.net/wordpress-breadcrumbs-without-a-plugin/](http://dimox.net/wordpress-breadcrumbs-without-a-plugin/)). Inserted using an action hook.\n\n* Long read prose (paragraphs etc) in single posts has increased font size for wide viewports, using CSS `clamp()`.\n\n## Dependencies\n\n* WordPress. 😎\n\n* Served from a CDN:\n  * Bootstrap v5.2.3 CSS\n  * Bootstrap v5.2.3 _bundle_ JS\n  * Bootstrap Icons v1.10.2\n\n* **Optional** (see “Preprocessing SCSS Files” below):\n  * NodeJS\n  * node-sass\n\n**Bootstrap Sass is not included.** But you can follow the instructions at [https://getbootstrap.com/docs/5.0/customize/sass/](https://getbootstrap.com/docs/5.0/customize/sass/) to bring Bootstrap Sass into your project.\n\n## Bootstrap Integration\n\n* Bootstrap navbar with WordPress menu and search.\n\t* Navbar dropdowns (child menus) are handled by a [custom walker nav menu class](https://github.com/SimonPadbury/b5st/blob/master/functions/navbar.php).\n\n* Bootstrap customized comments and feedback response form.\n\n## Gutenberg Compatibility\n\n* Gutenberg editor stylesheet – into which has been copy-pasted the typography styles from Bootstrap 5’s _Reboot_ CSS plus a few extras.\n\n* b5st has a centered narrow single-column layout, so that it can make use of Gutenberg’s extra-wide and full width blocks. In the front-end CSS, these are handled by a variation on Andy Bell’s [full bleed](https://hankchizljaw.com/wrote/creating-a-full-bleed-css-utility/) utility.\n\n## Child-Themes and b5st\n\n_I recommend you do not simply use b5st as-is, and then do all your designing in a child theme._\n\nb5st is only a meant to be a place to start a WordPress/Bootstrap 5 project. It is easier and better to directly rebuild b5st to suit your design needs. Besides, future improvements to b5st may make it not compatible with your child theme -- so, you may not be able to “upgrade” your project to a newer version of b5st simply by swapping it out.\n\nWith that said, you can develop child themes _based off your (b5st-based) project_. After you have taken and made b5st your own, modifying its layouts, styles etc. to create your own theme, and then deployed it on a live website, then you can later make child themes _from what will then be your (client’s) website theme_. For example, for special occasions you can make a child themes with alternate colors and backgrounds, seasonal layout changes, etc.\n\nTo aid you at that point, b5st has the following child-theme friendly features:\n\n* Many functions are pluggable.\n\n* Theme [hooks](/functions/hooks.php) – paired _before_ and _after_ the navbar, post/page main, (optional sidebar) and footer. Parent theme hooks are able to recieve [actions](https://developer.wordpress.org/plugins/hooks/actions/) from a child theme.\n\n* Also, the navbar brand, navbar search form and sub-footer “bottomline” are inserted using pluggable hooks. So, a child theme can override these.\n\n## Preprocessing SCSS Files\n\nIn the `theme/` folder there is a `scss/` folder containing all the SCSS files that have been used to create the file `theme/css/b5st.css`.\n\nYou can (beautify and) edit `b5st.css` directly — or you can preprocess the SCSS files using whatever you prefer to use. A simple way is to do the following:\n\n1. Install b5st (this theme) into your WordPress (local) development environment.\n\n2. Download and install [NodeJS](https://nodejs.org/), if you don’t have it already.\n\n3. In your terminal, `cd` into the `b5st` folder. Just do `npm install` so that `node-sass` gets installed as a dev dependancy (see the b5st `package.json`).\n\n4. You can then run `node-sass` in the terminal using `npm run scss`, and stop it using `ctrl+C`. `node-sass` will look for changes in SCSS files inside the `b5st/theme/scss` folder and output the CSS file(s) in the `b5st/theme/css` folder.\n\n5. Initially, only `b5st/theme/css/b5st.css` is enqueued in `functions/enqueues.php` (after the Bootstrap 5 enqueue). You can add more enqueues the same way.\n\n6. Your WordPress (local) development server likely has no live-refresh for when CSS files are modified in this way. So, manually do a browser refresh ↻ whenever you want to see your CSS changes.\n\n---\n\nSee the [LOG.md](/LOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonpadbury%2Fb5st","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonpadbury%2Fb5st","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonpadbury%2Fb5st/lists"}