www

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (1599B)

      1 [![Build Status,](https://img.shields.io/travis/jsmaniac/scribble-enhanced/main.svg)](https://travis-ci.org/jsmaniac/scribble-enhanced)
      2 [![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/scribble-enhanced/main.svg)](https://coveralls.io/github/jsmaniac/scribble-enhanced)
      3 [![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/scribble-enhanced)
      4 [![Online Documentation.](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/scribble-enhanced/)
      5 
      6 scribble-enhanced
      7 =================
      8 
      9 This `racket` package provides enhancements for the scribble library.
     10 
     11 Installation
     12 ------------
     13 
     14 Install with:
     15 
     16 ```
     17 raco pkg install --deps search-auto scribble-enhanced
     18 ```
     19 
     20 This library is unstable
     21 ------------------------
     22 
     23 For now, this package's API should be considered unstable.
     24 Append `#COMMIT_NUMBER` at the end of `…scribble-enhanced.git`
     25 in the command-line above to specify a version to install
     26 (it will not be automatically updated by `raco pkg update` that way).
     27 
     28 Files
     29 -----
     30 
     31 * `doc.rkt`
     32   Enhancements and utilities for documentation and literate programming files
     33   using scribble and scribble/lp2.
     34 
     35 * `math.rkt`
     36 
     37   Allows typesetting mathematical formulas in documentation and literate
     38   programming files using scribble and scribble/lp2.
     39 
     40 * `scribblings/scribble-enhanced-template.lp2.rkt`
     41 
     42   Example document using the features in `doc.rkt` and `math.rkt`.
     43 
     44 * `scribblings/scribble-enhanced-example.lp2.rkt`
     45 
     46   Other simpler example document using the features in `doc.rkt` and
     47   `math.rkt`.