Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.
/ nui Public archive

Spinneret tags for composing Lisp documentation and other text-centric interfaces.

License

Notifications You must be signed in to change notification settings

atlas-engineer/nui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NUI

NUI is abandoned due to being overly complicated and hard to integrate into Nyxt

NUI is a set of Spinneret tags useful in documentation, blog posts, and other text-centric HTML interfaces. It originates from Nyxt, where it’s used in the manual and help system.

The tags that NUI provides are:

  • Text/structure tags:
    :nsection
    section, its heading with a link to itself, and a linkable ID.
    :ntoc
    auto-generated Table of Contents for the provided HTML.
  • Lisp-specific tags:
    :nkey
    Emacs-like key rendering with CUA notation as a tooltip.
    :ncode
    Lisp (or non-Lisp) code listing, enriched with symbol references and customizable actions.
    :nxref
    reference to a symbol in a configurable documentation source.
  • Interactive tags:
    :nbutton
    a button invoking the action you provide.
    :nselect
    <select> tag with actions bound to it.
    :ninput
    input area tracking every modification and focus.

Getting started

Clone the Git repository:

git clone --recursive https://github.com/atlas-engineer/nui ~/common-lisp/

And then load :nui in the REPL:

(asdf:load-system :nui)
;; or, if you use Quicklisp
(ql:quickload :nui)

Tag helpers

NUI exposes a set of methods that define how to process tag arguments and bodies. One has to specialize these methods before using NUI.

History

NFiles was originally developed for user file management in Nyxt, so the “N” may stand for it, or “New”, or whatever poetic meaning you may find behind it!

About

Spinneret tags for composing Lisp documentation and other text-centric interfaces.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published