admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

badges done

Browse source
This commit is contained in:
Julie Kirsch 2024-12-26 19:07:30 +01:00
parent 185b4c7cdd
commit 868541ce8e
1 changed files with 21 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

52
book/basic-features/badges.md
View file

@ -6,39 +6,29 @@
Badges are small visual indicators often used to convey concise or important information. They can be very useful for categorising or tagging content for the reader like has been done for the subchapters under the [features](../features/overview.md) chapter of this manual. There are three types of badges: plain, link and reference. They are fully customizable and can simply be added with Markdown syntax:
| Badge Preview | Code Syntax |
|-----------------------------------------------------------------|-------------------------------|
| {bdg-primary}`plain_text` | `{bdg-primary}`plain_text`` |
| {bdg-link-primary}`https://teachbooks.io/` | `{bdg-link-primary}`https://teachbooks.io/`` |
| {bdg-link-primary}`TeachBooks <https://https://teachbooks.io/>` | `{bdg-link-primary}`TeachBooks <https://https://teachbooks.io/>`` |
| {bdg-ref-primary}`my_ref` | `{bdg-ref-primary}`my_ref`` |
| Types of badge | Code Syntax |
|-----------------------------------------------------------------|------------------------------------------------------------------------|
| {bdg-primary}`plain_text` | ` {bdg-primary}`plain_text` ` |
| {bdg-link-primary}`https://teachbooks.io/` | ` {bdg-link-primary}`https://teachbooks.io/` ` |
| {bdg-link-primary}`TeachBooks <https://https://teachbooks.io/>` | ` {bdg-link-primary}`TeachBooks < https://https://teachbooks.io/ > ` ` |
| {bdg-ref-primary}`my_ref` | `{bdg-ref-primary}`my_ref` ` |
Here's an overview of all the available colours:
| Badge Preview | Code Syntax |
|-------------------------------|-------------------------------|
| {bdg}`my_text` | `{bdg}`my_text`` |
| {bdg-primary}`my_text` | `{bdg-primary}`my_text`` |
| {bdg-primary-line}`my_text` | `{bdg-primary-line}`my_text`` |
| {bdg-secondary}`my_text` | `{bdg-secondary}`my_text`` |
| {bdg-secondary-line}`my_text` | `{bdg-secondary-line}my_text` |
| {bdg-success}`my_text` | `{bdg-success}my_text` |
| {bdg-success-line}`my_text` | `{bdg-success-line}my_text` |
| {bdg-info}`my_text` | `{bdg-info}my_text` |
| {bdg-info-line}`my_text` | `{bdg-info-line}my_text` |
| {bdg-warning}`my_text` | `{bdg-warning}my_text` |
| {bdg-warning-line}`my_text` | `{bdg-warning-line}my_text` |
| {bdg-danger}`my_text` | `{bdg-danger}my_text` |
| {bdg-danger-line}`my_text` | `{bdg-danger-line}my_text` |
| {bdg-light}`my_text` | `{bdg-light}my_text` |
| {bdg-light-line}`my_text` | `{bdg-light-line}my_text` |
| {bdg-muted}`my_text` | `{bdg-muted}my_text` |
| {bdg-muted-line}`my_text` | `{bdg-muted-line}my_text` |
| {bdg-dark}`my_text` | `{bdg-dark}my_text` |
| {bdg-dark-line}`my_text` | `{bdg-dark-line}my_text` |
| {bdg-white}`my_text` | `{bdg-white}my_text` |
| {bdg-white-line}`my_text` | `{bdg-white-line}my_text` |
| {bdg-black}`my_text` | `{bdg-black}my_text` |
| {bdg-black-line}`my_text` | `{bdg-black-line}my_text` |
| Full Colour | Code Syntax | Colour Outline | Code Syntax |
|-------------------------------|-------------------------------|-------------------------------|-----------------------------------|
| {bdg}`my_text` | ` {bdg}`my_text` ` | | |
| {bdg-primary}`my_text` | ` {bdg-primary}`my_text` ` | {bdg-primary-line}`my_text` | ` {bdg-primary-line}`my_text` ` |
| {bdg-secondary}`my_text` | `{bdg-secondary}`my_text`` | {bdg-secondary-line}`my_text` | ` {bdg-secondary-line}`my_text` ` |
| {bdg-success}`my_text` | `{bdg-success}my_text` | {bdg-success-line}`my_text` | ` {bdg-success-line}`my_text` ` |
| {bdg-info}`my_text` | `{bdg-info}my_text` | {bdg-info-line}`my_text` | ` {bdg-info-line}`my_text` ` |
| {bdg-warning}`my_text` | `{bdg-warning}my_text` | {bdg-warning-line}`my_text` | ` {bdg-warning-line}`my_text` ` |
| {bdg-danger}`my_text` | `{bdg-danger}my_text` | {bdg-danger-line}`my_text` | ` {bdg-danger-line}`my_text` ` |
| {bdg-light}`my_text` | `{bdg-light}my_text` | {bdg-light-line}`my_text` | ` {bdg-light-line}`my_text` ` |
| {bdg-muted}`my_text` | `{bdg-muted}my_text` | {bdg-muted-line}`my_text` | ` {bdg-muted-line}`my_text` ` |
| {bdg-dark}`my_text` | `{bdg-dark}my_text` | {bdg-dark-line}`my_text` | ` {bdg-dark-line}`my_text` ` |
| {bdg-white}`my_text` | `{bdg-white}my_text` | {bdg-white-line}`my_text` | ` {bdg-white-line}`my_text` ` |
| {bdg-black}`my_text` | `{bdg-black}my_text` | {bdg-black-line}`my_text` | ` {bdg-black-line}`my_text` ` |
## Buttons