Skip to content

Latest commit

 

History

History
118 lines (81 loc) · 5.18 KB

README.md

File metadata and controls

118 lines (81 loc) · 5.18 KB
Raw

Software License Bludit 3.15.x Bludit 3.16.x

bs5docs Theme for Bludit

bs5docs is a Bootstrap 5 theme for Bludit

Description

BS5Docs is a Bootstrap 5.3.x theme for Bludit. It serves Bootstrap locally and does not use Bludit's included Bootstrap.

The intended use case is to create online documentation.

It is, to some extent, inspired by the Bootstrap 5 documentation site, as well as the Bludit DocX theme.

The theme is responsive, multi-device friendly, and supports light and dark mode automatically. It should also play nicely with screen readers (ARIA) and similar devices.

  • automatic detection of light and dark mode, as configured in the browser
  • sidebar; sidebar content will be displayed on the MORE menu
  • social media links; social media links will be displayed on MORE menu
  • RSS feed; the RSS link will be displayed on MORE menu
  • static pages and static sub pages; these are used to create your online documentation
  • regular pages and sticky pages are displayed in the "home" context
  • homepage can be set as the start of your documentation, or empty for a blog like starting point
  • page description, site slogan, and site description
  • pagenotfound
  • footer, if configured in Bludit, will be displayed in the left navigation bar and on the off-canvas menu
  • browsing by tag
  • searching for content; the search box will be displayed on MORE menu if enabled in Bludit
  • date format automatically take the configured locale into account
  • no icon kit is used, instead the theme uses Emoji where needed

The theme contains no tracking code of any kind, nor does it load any external resources

Demo

You can see this theme in action on bludit-bs5docs.joho.se

Requirements

Bludit version 3.15.x or 3.16.x

Installation

  1. Download the latest release from the repository
  2. Extract the zip file into a folder, such as tmp
  3. Upload the bs5docs folder to your web server or hosting and put it in the bl-themes folder where Bludit is installed
  4. Go your Bludit admin page
  5. Klick on Themes and activate the bs5docs theme

Changelog

1.0.1 (2024-09-05)

  • Very minor cleanup

1.0.0 (2024-08-30)

  • Initial release

Other notes

This theme has only been tested with PHP 8.1.x, but should work with other versions too. If you find an issue with your specific PHP version, please let me know and I will look into it.

License

Please see LICENSE for a full copy of AGPLv3.

Copyright 2024 Joaquim Homrighausen; all rights reserved.

This file is part of bs5docs. bs5docs is free software.

bs5docs is free software: you may redistribute it and/or modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE v3 as published by the Free Software Foundation.

bs5docs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU AFFERO GENERAL PUBLIC LICENSE v3 for more details.

You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE v3 along with the bs5docs package. If not, write to:

The Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor
Boston, MA  02110-1301, USA.

Credits

Logos and graphics

Other credits

The bs2docs theme was written by Joaquim Homrighausen while converting ☕ into code.

The bs2docs theme is sponsored by WebbPlatsen i Sverige AB, Sweden 🇸🇪

Commercial support and customizations for this plugin is available from WebbPlatsen i Sverige AB.

If you find this plugin useful, feel free to purchase BS5Docs Pro 😊

If there is something you feel to be missing from this plugin, or if you have found a problem with the code or a feature, please do not hesitate to reach out to [email protected].