101 lines
4 KiB
Org Mode
101 lines
4 KiB
Org Mode
# -*- mode: org; -*-
|
|
* dev.metalisp.sbt
|
|
|
|
THIS REPOSITORY IS A LIVING LIBRARY. IT IS UPDATED ON A REGULAR BASE INCLUDING BREAKING CHANGES!
|
|
|
|
** Motivation
|
|
As a user experience designer, one of my tasks is to document the information architecture. Most people use diagramming tools for this task. But I could never get familiar with these tools. For many years I have liked the idea of documenting information architecture using HTML. Writing HTML is tedious and takes a lot of time. That is why I came up with the idea to develop a library of macros that can be used to document the information architecture in an easy way and generate the HTML to have a document that I can then share with my users to get feedback.
|
|
|
|
** Introduction
|
|
|
|
A Common Lisp library for generating Bootstrap-based HTML markup. It provides
|
|
macros to easily create Bootstrap components such as accordions, alerts,
|
|
badges, buttons, cards, dropdowns, headers, list groups, navbars, nav-tabs,
|
|
pagination, and tables. This library is dependent on the Spinneret library for
|
|
HTML generation.
|
|
|
|
The following components are available as packages:
|
|
|
|
- accordion :: This package provides macros for generating Bootstrap Accordion
|
|
components. Accordions are collapsible lists of items, each of which can be
|
|
"expanded" or "collapsed" to reveal or hide content.
|
|
|
|
- alert :: This package offers macros for creating Bootstrap Alert components.
|
|
Alerts are used to provide user feedback, usually in response to user
|
|
interactions, such as form validation or actions.
|
|
|
|
- badge :: This package provides macros for creating Bootstrap Badge
|
|
components. Badges are small status descriptors for UI elements. They can be
|
|
used to add additional information to an element, such as a count.
|
|
|
|
- button :: This package provides macros for creating Bootstrap Button
|
|
components. Buttons are used for actions, like submitting forms or initiating
|
|
actions.
|
|
|
|
- card :: This package provides macros for creating Bootstrap Card components.
|
|
Cards are flexible and extensible containers for displaying content in a
|
|
structured format.
|
|
|
|
- dropdown :: This package provides macros for creating Bootstrap Dropdown
|
|
components. Dropdowns are toggleable, contextual overlays for displaying
|
|
lists of links and actions in a dropdown format.
|
|
|
|
- list group :: This package provides macros for generating Bootstrap List
|
|
Group components. List groups are flexible and powerful components for
|
|
displaying not only simple lists of elements, but complex ones with custom
|
|
content.
|
|
|
|
- navbar :: This package provides macros for creating Bootstrap Navbar
|
|
components. Navbars are responsive meta components that serve as navigation
|
|
headers for your application or site.
|
|
|
|
- nav / tab :: This package provides macros for creating Bootstrap Nav
|
|
components. Navs are navigation components that can be styled in different
|
|
ways and can contain links, text, or any other kind of content.
|
|
|
|
- pagination :: This package provides macros for creating Bootstrap Pagination
|
|
components. Pagination is used to let the user navigate through a set of
|
|
discrete pages.
|
|
|
|
- table :: This package provides macros for generating Bootstrap Table
|
|
components. Tables are used to present data in a tabular format.
|
|
|
|
- spinner :: This package provides macros for creating Bootstrap Spinner
|
|
components. Spinners are used to indicate a loading state of a page or a
|
|
section.
|
|
|
|
** Installation
|
|
|
|
#+begin_src bash
|
|
git clone https://code.metalisp.dev/marcuskammer/dev.metalisp.sbt.git ~/quicklisp/local-projects/
|
|
#+end_src
|
|
|
|
*** Load library
|
|
|
|
#+begin_src lisp
|
|
(ql:quickload :dev.metalisp.sbt)
|
|
#+end_src
|
|
|
|
** XMPP (Jabber) Chat
|
|
|
|
- metalisp@conference.mailbox.org
|
|
|
|
** RSS Feed
|
|
|
|
- https://code.metalisp.dev/marcuskammer/dev.metalisp.sbt.atom
|
|
|
|
** Similar Libraries
|
|
|
|
- https://github.com/rmhsilva/semantic-spinneret
|
|
|
|
- https://github.com/thephoeron/cl-bootstrap
|
|
|
|
- https://github.com/rajasegar/cl-bootstrap/
|
|
|
|
** Author
|
|
|
|
- Marcus Kammer (marcus.kammer@mailbox.org)
|
|
|
|
** Copyright
|
|
|
|
Copyright (c) 2023 Marcus Kammer (marcus.kammer@mailbox.org)
|