diff --git a/README.md b/README.md deleted file mode 100644 index 9bd8b78..0000000 --- a/README.md +++ /dev/null @@ -1,158 +0,0 @@ - -# Table of Contents - -1. [dev.metalisp.sbt](#org34e2de9) - 1. [Introduction](#org0598841) - 2. [Installation](#org0102225) - 1. [Load library](#org3c2e2b5) - 2. [Run tests](#org9fb428e) - 3. [Issue Tracker](#org547939f) - 4. [Mailing list](#orga4368de) - 5. [XMPP (Jabber) Chat](#org9528711) - 6. [RSS Feed](#org7c3ae8d) - 7. [Similar Libraries](#org7c30993) - 8. [Author](#org6fb104a) - 9. [Copyright](#org6ee8fc7) - - - - -# dev.metalisp.sbt - - - - -## 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 - - git clone https://git.sr.ht/~marcuskammer/dev.metalisp.sbt ~/quicklisp/local-projects/dev.metalisp.sbt/ - - - - -### Load library - - (ql:quickload :dev.metalisp.sbt) - - - - -### Run tests - - cd ~/quicklisp/local-projects/dev.metalisp.sbt/ - - sh run-tests.sh - - - - -## Issue Tracker - -- - - - - -## Mailing list - -- - - - - -## XMPP (Jabber) Chat - -- metalisp@conference.mailbox.org - - - - -## RSS Feed - -- - - - - -## Similar Libraries - -- - -- - -- - - - - -## Author - -- Marcus Kammer (marcus.kammer@metalisp.dev) - - - - -## Copyright - -Copyright (c) 2023 Marcus Kammer (marcus.kammer@metalisp.dev) - diff --git a/README b/README.org similarity index 87% rename from README rename to README.org index 232106e..b4749ea 100644 --- a/README +++ b/README.org @@ -71,30 +71,13 @@ The following components are available as packages: (ql:quickload :dev.metalisp.sbt) #+end_src -*** Run tests - -#+begin_src bash - cd ~/quicklisp/local-projects/dev.metalisp.sbt/ -#+end_src - -#+begin_src bash - sh run-tests.sh -#+end_src - -** Issue Tracker - -- [[https://todo.sr.ht/~marcuskammer/metalisp]] - -** Mailing list - -- [[https://lists.sr.ht/~marcuskammer/metalisp]] - ** XMPP (Jabber) Chat + - metalisp@conference.mailbox.org ** RSS Feed -- https://git.sr.ht/~marcuskammer/dev.metalisp.sbt/log/main/rss.xml +- https://code.metalisp.dev/marcuskammer/dev.metalisp.survey.rss ** Similar Libraries @@ -106,8 +89,8 @@ The following components are available as packages: ** Author -- Marcus Kammer (marcus.kammer@metalisp.dev) +- Marcus Kammer (marcus.kammer@mailbox.org) ** Copyright -Copyright (c) 2023 Marcus Kammer (marcus.kammer@metalisp.dev) +Copyright (c) 2023 Marcus Kammer (marcus.kammer@mailbox.org)