https://github.com/alexknauth/scribble-code-examples

A scribble examples form that works for non-s-expression languages
https://github.com/alexknauth/scribble-code-examples

documentation-tool racket

Last synced: about 1 month ago
JSON representation

A scribble examples form that works for non-s-expression languages

• Host: GitHub
• URL: https://github.com/alexknauth/scribble-code-examples
• Owner: AlexKnauth
• License: mit
• Created: 2015-05-12T20:44:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-17T00:15:54.000Z (9 months ago)
• Last Synced: 2024-10-16T02:55:10.649Z (3 months ago)
• Topics: documentation-tool, racket
• Language: Racket
• Homepage:
• Size: 20.5 KB
• Stars: 7
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# scribble-code-examples

A scribble examples form that works for non-s-expression languages

Documentation: https://docs.racket-lang.org/scribble-code-examples/index.html

This repository contains two packages:

 - `scribble-code-examples-lib`, contains the `scribble-code-examples` module but no docs or tests

 - `scribble-code-examples`, contains the documentation and tests

```racket

(require scribble-code-examples)

```

In a Scribble Documentation file, writing this:

```racket

@code-examples[#:lang "at-exp racket" #:context #'here]|{

(+ 1 2)

@+[1 3]

}|

```

Produces output that shows a Repl interaction like this:

```racket

> (+ 1 2)

3

> @+[1 3]

4

```