Update README

This commit is contained in:
Marcus Kammer 2023-07-14 19:54:28 +02:00
parent a720990cef
commit f7853680b8
Signed by: marcuskammer
GPG key ID: C374817BE285268F
2 changed files with 33 additions and 23 deletions

View file

@ -1,16 +1,4 @@
# Table of Contents
1. [Cl-Sbt](#org6af45e7)
1. [Usage](#org4b1729c)
1. [Defining a Card](#org8a876fa)
2. [Defining a Dropdown](#orgcb10ca2)
2. [Installation](#org0da4cf2)
3. [Author](#org919d853)
4. [Copyright](#orgc51162e)
<a id="org6af45e7"></a>
# Cl-Sbt # Cl-Sbt
@ -20,14 +8,25 @@ badges, buttons, cards, dropdowns, headers, list groups, navbars, nav-tabs,
pagination, and tables. This library is dependent on the Spinneret library for pagination, and tables. This library is dependent on the Spinneret library for
HTML generation. HTML generation.
The following components are available and are packages:
- accordion
- alert
- badge
- button
- card
- dropdown
- list group
- navbar
- nav / tab
- pagination
- table
- spinner
<a id="org4b1729c"></a>
## Usage ## Usage
<a id="org8a876fa"></a>
### Defining a Card ### Defining a Card
The following code demonstrates how to define a card using the card macro. The following code demonstrates how to define a card using the card macro.
@ -72,8 +71,6 @@ The following code demonstrates how to define a card using the card-with-img mac
</div> </div>
<a id="orgcb10ca2"></a>
### Defining a Dropdown ### Defining a Dropdown
The following code demonstrates how to define a dropdown using the dropdown The following code demonstrates how to define a dropdown using the dropdown
@ -97,8 +94,6 @@ macro.
</div> </div>
<a id="org0da4cf2"></a>
## Installation ## Installation
git clone https://git.sr.ht/~marcuskammer/cl-sbt ~/quicklisp/local-projects/cl-sbt/ git clone https://git.sr.ht/~marcuskammer/cl-sbt ~/quicklisp/local-projects/cl-sbt/
@ -106,15 +101,11 @@ macro.
(ql:quickload :cl-sbt) (ql:quickload :cl-sbt)
<a id="org919d853"></a>
## Author ## Author
- Marcus Kammer (marcus.kammer@mailbox.org) - Marcus Kammer (marcus.kammer@mailbox.org)
<a id="orgc51162e"></a>
## Copyright ## Copyright
Copyright (c) 2023 Marcus Kammer (marcus.kammer@mailbox.org) Copyright (c) 2023 Marcus Kammer (marcus.kammer@mailbox.org)

View file

@ -1,3 +1,7 @@
#+author: Marcus Kammer
#+email: marcus.kammer@mailbox.org
#+options: toc:nil
* Cl-Sbt * Cl-Sbt
A Common Lisp library for generating Bootstrap-based HTML markup. It provides A Common Lisp library for generating Bootstrap-based HTML markup. It provides
@ -6,6 +10,21 @@ badges, buttons, cards, dropdowns, headers, list groups, navbars, nav-tabs,
pagination, and tables. This library is dependent on the Spinneret library for pagination, and tables. This library is dependent on the Spinneret library for
HTML generation. HTML generation.
The following components are available and are packages:
- accordion
- alert
- badge
- button
- card
- dropdown
- list group
- navbar
- nav / tab
- pagination
- table
- spinner
** Usage ** Usage
*** Defining a Card *** Defining a Card