Stack Overflow
Stack Overflow

Questions tagged [scribble]

Scribble is a domain specific language used for documentation in the Racket eco-system.

Scribble is a syntax and a collection of tools for creating prose documents—papers, books, library documentation, etc.—in HTML or PDF (via Latex) form. More generally, the Scribble syntax is useful for programs that are rich in textual content, whether the it is prose to be typeset or any other form of text to be generated programmatically.

Scribble Introductory Video

Scribble: Closing the Book on Ad Hoc Documentation Tools

49 questions
6
votes
2 answers

Examples on Literate Programming with Racket scribble/lp

In addition to learning Racket I'm trying to learn literate programming. Unfortunately the Racket documentation is sparse to say the least with regards to scribble/lp. Could someone point me to some better resources on this subject or examples of…
ggelfond
  • 321
  • 1
  • 2
  • 5
5
votes
1 answer

"Docstrings" in Racket?

I know Racket doesn't have "docstrings" in the same way that many other languages do, but given how convenient documenting things at the source is, I'd like to approximate something like it in Racket. When I first learned about Scribble and #langs,…
mindthief
  • 12,755
  • 14
  • 57
  • 61
5
votes
1 answer

scribble: how to remove "WARNING no declared exporting libraries"

I'm trying to use defproc to format a function definition (not to document a library). The code below gets the formatting right, but prints an ugly warning to the console when I run Scribble: #lang scribble/manual @require[(for-label…
Ben Greenman
  • 1,945
  • 12
  • 22
5
votes
2 answers

How to add non scribble file to a scribble based website

I can use image to embed an image in my scribble document, and the render function will copy it to the target destination. Now, I would also like to include files with my document that is not an image, such as an MP3 or PDF file that can be…
Leif Andersen
  • 21,580
  • 20
  • 67
  • 100
5
votes
1 answer

Unresolved Links in scribble/lp document

I'm trying to write a small example program in Racket's scribble/lp. The source for the project is on Github. The problem I am experiencing is broken links in the woven html. I've provided it as a gh-page. for the project. When outputting the…
ben rudgers
  • 3,647
  • 2
  • 20
  • 32
5
votes
2 answers

How to use `typed/racket` in `scribble/lp`

Is it possible to use other #langs in #lang scribble/lp for literate programming? For example, I want to use #lang typed/racket in #lang scribble/lp. How to realize that?
Ben
  • 3,612
  • 3
  • 19
  • 24
4
votes
1 answer

How can I use tech as a contract in defproc?

Is it possible to have @defproc[(foo) bar]{ Blah blah } where bar is defined via deftech while linking to bar correctly?
Sorawee Porncharoenwase
  • 6,305
  • 1
  • 14
  • 28
4
votes
1 answer

How to re-export #%module-begin etc from scribble/text?

I want a language like scribble/text but with some additional functions offered. This is what I've tried: #lang racket/base (require scribble/text) (provide (all-from-out scribble/text) hello) (define (hello name) (format "Hello ~a!"…
Richard Parsons
  • 277
  • 1
  • 9
4
votes
1 answer

Racket scribble not showing hyperlinks

I have tried following code statements to show a URL: #lang scribble/base @title{Testing Hyperlinks} @section{URLs} Getting started: @hyperlink["https://docs.racket-lang.org/scribble/getting-started.html"] Getting started:…
rnso
  • 23,686
  • 25
  • 112
  • 234
4
votes
1 answer

Racket Scribble, How to add a searchbox?

I used scribble to generate my package's document. And raco will integate my douments with racket self's documents, and add a searchbox on the topleft of the page. You can see that when you use "raco docs". Now I want use scribble as a document…
simmone
  • 379
  • 1
  • 11
4
votes
3 answers

Change font color in Scribble (html backend)

Is there any way to change the font color in scribble with an HTML backend? (More specifically, I want to put a large red WARNING label in the manual for a library.)
Leif Andersen
  • 21,580
  • 20
  • 67
  • 100
4
votes
3 answers

What's the function to render scribble string with the environment in a hash table?

I'm new to using scribble, but I can't work out how to use its syntax in my own programs, rather than using a scribble language. > (define ht (make-hash '(("Name" . "Simon")))) > (define template "Hello @Name") > (function-i-dont-know ht…
Richard Parsons
  • 277
  • 1
  • 9
4
votes
3 answers

Intuitive motivation for Literate Programming?

So, I used the scribble/lp module to write my first literate program using plt-scheme: #lang scribble/lp (require scribble/lp) <> @chunk[ (define (f x) (* x x))] Nothing useful there, of course. Now…
user59634
3
votes
1 answer

How to Link to an Alias in Scribble Documentation for a Procedure?

In writing Scribble docs for a function, I'd like to link to a built-in function that has the same name as a different function that's being documented in the same Scribble file. Normally @racketlink is usable for this purpose (together with…
mindthief
  • 12,755
  • 14
  • 57
  • 61
3
votes
1 answer

Create a new page in scribble with pdf/latex backend

In latex, I can create a new page with the \newpage command. There does not seem to be any way to do this directly in Scribble (at least not for a PDF/Latex back end.) So, how can I force scribble to make me new page for my document?
Leif Andersen
  • 21,580
  • 20
  • 67
  • 100
1
2 3 4