-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
29 additions
and
821 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| # bs5docs Theme for Bludit | ||
|
|
||
| bs5docs is a Bootstrap 5 theme for Bludit 3.15.x and 3.16.x | ||
| bs5docs is a Bootstrap 5 theme for Bludit | ||
|
|
||
| ## Description | ||
|
|
||
|
|
@@ -15,51 +15,41 @@ It is, to some extent, inspired by the Bootstrap 5 documentation site, as well a | |
| 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 off-canvas menu | ||
| * **social media links**; social media links will be displayed on the off-canvas menu | ||
| * **RSS feed**; the RSS link will be displayed on the off-canvas menu | ||
| * **static pages**; these are displayed as buttons at the top of the page | ||
| * **static sub pages**; these are _not_ displayed at the top of the page | ||
| * **sub pages** are not displayed in the "home" context | ||
| * **sub pages** of a page displayed are shown before the page content, below the title | ||
| * the **parent page** of a page displayed is shown before the page content, below the title | ||
| * **page description**; this is only used for the page's META description, and is not displayed | ||
| * **site slogan** and **site description** | ||
| * **footer**, if configured in Bludit, will be displayed in, well, the footer | ||
| * browsing by tag and category | ||
| * **searching for content**; the search box will be displayed on the off-canvas menu if enabled in Bludit | ||
| * Bludit's **date format** setting is honored when displaying dates | ||
| * **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-bs5plain.joho.se](https://bludit-bs5plain.joho.se) | ||
| You can see this theme in action on [bludit-bs5docs.joho.se](https://bludit-bs5docs.joho.se) | ||
|
|
||
| ## Requirements | ||
|
|
||
| Bludit version 3.15.x | ||
| 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 `bs5plain` folder to your web server or hosting and put it in the `bl-themes` folder where Bludit is installed | ||
| 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 `bs5plain` theme | ||
| 5. Klick on Themes and activate the `bs5docs` theme | ||
|
|
||
| ## Changelog | ||
|
|
||
| ### 1.0.2 (2024-XX-XX) | ||
| * Images in post content should now behave like Bootstrap's "img-thumbnail" and be more responsive. | ||
|
|
||
| ### 1.0.1 (2024-07-11) | ||
| * Static pages without a title are no longer displayed in the upper right-hand corner | ||
| * The title of the page configured as "Page not found" is no longer displayed | ||
| * The page configured as "Page not found" is no longer displayed in the "blog flow" (home) | ||
|
|
||
| ### 1.0.0 (2024-07-09) | ||
| ### 1.0.0 (2024-08-30) | ||
| * Initial release | ||
|
|
||
| ## Other notes | ||
|
|
@@ -72,19 +62,19 @@ Please see [LICENSE](LICENSE) for a full copy of AGPLv3. | |
|
|
||
| Copyright 2024 [Joaquim Homrighausen](https://github.com/joho1968); all rights reserved. | ||
|
|
||
| This file is part of bs5plain. bs5plain is free software. | ||
| This file is part of bs5docs. bs5docs is free software. | ||
|
|
||
| bs5plain is free software: you may redistribute it and/or modify it under | ||
| 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. | ||
|
|
||
| bs5plain is distributed in the hope that it will be useful, but WITHOUT | ||
| 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 bs5plain package. If not, write to: | ||
| along with the bs5docs package. If not, write to: | ||
| ``` | ||
| The Free Software Foundation, Inc., | ||
| 51 Franklin Street, Fifth Floor | ||
|
|
@@ -103,19 +93,22 @@ Boston, MA 02110-1301, USA. | |
| * Xing icon: https://commons.wikimedia.org/wiki/File:Ionicons_logo-xing.svg | ||
| * LinkedIn icon: https://commons.wikimedia.org/wiki/File:LinkedIn_icon.svg | ||
| * VK icon: https://commons.wikimedia.org/wiki/File:B%26W_Vk_icon.png | ||
| * Telegram Icon: https://commons.wikimedia.org/wiki/File:Telegram_logo_icon.svg | ||
| * CodePen icon: CodePen | ||
| * GitHub icon: GitHub | ||
| * GitLab icon: GitLab | ||
|
|
||
| ### Other credits | ||
|
|
||
| * Bootstrap for the [Bootstrap 5](https://getboostrap.com) framework | ||
| * Bootstrap for the [Bootstrap 5](https://getboostrap.com) framework :blush: | ||
| * Kudos to [Diego Najar](https://github.com/dignajar) for [Bludit](https://bludit.com) :blush: | ||
| * Kudos to [Ivan Sagalaev](https://github.com/isagalaev) for [highlight.js](https://highlightjs.org) :blush: | ||
|
|
||
| The bs2plain theme was written by Joaquim Homrighausen while converting :coffee: into code. | ||
| The bs2docs theme was written by Joaquim Homrighausen while converting :coffee: into code. | ||
|
|
||
| The bs5plain theme is sponsored by [WebbPlatsen i Sverige AB](https://webbplatsen.se), Stockholm, :sweden: Commercial support and customizations for this plugin is available from WebbPlatsen i Sverige AB in Stockholm, :sweden: | ||
| The bs2docs theme is sponsored by [WebbPlatsen i Sverige AB](https://webbplatsen.se), Sweden :sweden: | ||
| Commercial support and customizations for this plugin is available from WebbPlatsen i Sverige AB. | ||
|
|
||
| If you find this plugin useful, the author is happy to receive a donation, good review, or just a kind word. | ||
| If you find this plugin useful, feel free to purchase BS5Docs Pro :blush: | ||
|
|
||
| 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]. | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.