https://github.com/suzannesoy/scribble-enhanced

Enhancements for the scribble language (a documentation language based on Racket)
https://github.com/suzannesoy/scribble-enhanced

racket-library

Last synced: 5 months ago
JSON representation

Enhancements for the scribble language (a documentation language based on Racket)

• Host: GitHub
• URL: https://github.com/suzannesoy/scribble-enhanced
• Owner: SuzanneSoy
• License: other
• Created: 2016-04-01T13:27:01.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2023-01-27T19:36:26.000Z (over 3 years ago)
• Last Synced: 2025-01-30T11:42:05.784Z (over 1 year ago)
• Topics: racket-library
• Language: Racket
• Homepage: http://docs.racket-lang.org/scribble-enhanced/
• Size: 7.99 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![Build Status,](https://img.shields.io/travis/jsmaniac/scribble-enhanced/main.svg)](https://travis-ci.org/jsmaniac/scribble-enhanced)

[![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/scribble-enhanced/main.svg)](https://coveralls.io/github/jsmaniac/scribble-enhanced)

[![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/scribble-enhanced)

[![Online Documentation.](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/scribble-enhanced/)

scribble-enhanced

=================

This `racket` package provides enhancements for the scribble library.

Installation

------------

Install with:

```

raco pkg install --deps search-auto scribble-enhanced

```

This library is unstable

------------------------

For now, this package's API should be considered unstable.

Append `#COMMIT_NUMBER` at the end of `…scribble-enhanced.git`

in the command-line above to specify a version to install

(it will not be automatically updated by `raco pkg update` that way).

Files

-----

* `doc.rkt`

  Enhancements and utilities for documentation and literate programming files

  using scribble and scribble/lp2.

* `math.rkt`

  Allows typesetting mathematical formulas in documentation and literate

  programming files using scribble and scribble/lp2.

* `scribblings/scribble-enhanced-template.lp2.rkt`

  Example document using the features in `doc.rkt` and `math.rkt`.

* `scribblings/scribble-enhanced-example.lp2.rkt`

  Other simpler example document using the features in `doc.rkt` and

  `math.rkt`.