94fa0a30d2
Markdown: fix defmodule to avoid printing the package in the example fix markdown example file to make test pass original commit: fc3321481ce9928eaeea393302a0c0f187937271
101 lines
2.2 KiB
Racket
101 lines
2.2 KiB
Racket
#lang scribble/manual
|
|
|
|
@(require scribble/eval
|
|
(for-label racket/base racket/contract racket/string))
|
|
@(define my-eval (make-base-eval))
|
|
@(my-eval '(require racket/base))
|
|
|
|
@title{Title}
|
|
|
|
@section{Section}
|
|
|
|
This is a top-level section.
|
|
|
|
@subsection{Subsection}
|
|
|
|
This is a subsection.
|
|
|
|
@subsubsection{Subsubsection}
|
|
|
|
This is a subsubsection.
|
|
|
|
Here is an itemize:
|
|
|
|
@itemize[
|
|
@item{Item 1.}
|
|
@item{Item 2.}
|
|
]
|
|
|
|
Here is a hyperlink:
|
|
|
|
@hyperlink["http://racket-lang.org/" "I am a hyperlink to Racket."]
|
|
|
|
@italic{Italic}.
|
|
_Just underlines_.
|
|
|
|
@bold{Bold}.
|
|
*Just asterisks.*
|
|
|
|
``Dobule quoted''.
|
|
`Single quoted'.
|
|
|
|
This should NOT be `code` in Markdown.
|
|
|
|
Example of vebatim:
|
|
|
|
@verbatim{
|
|
Hi, world.
|
|
A ``quote''.
|
|
Second line.
|
|
Last line.
|
|
}
|
|
|
|
Another example of verbatim, with ticks/quotes:
|
|
|
|
@verbatim{
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
}
|
|
|
|
Example of a defmodule:
|
|
|
|
@defmodule[racket/string #:packages ()]
|
|
|
|
Example of a defproc:
|
|
|
|
@defproc[(make-string [k exact-nonnegative-integer?][char char? #\nul]) string?]{
|
|
|
|
Returns a new mutable string of length @racket[k] where each position in the
|
|
string is initialized with the character @racket[char]
|
|
|
|
Blah blah @racket[(or/c string? bytes?)].
|
|
|
|
}
|
|
|
|
Example of Scribble @racket[examples]:
|
|
|
|
@examples[#:eval my-eval
|
|
(define x 0)
|
|
(displayln x)
|
|
]
|
|
|
|
Example of Scribble @racket[interaction]:
|
|
|
|
@interaction[#:eval my-eval
|
|
(define x 0)
|
|
x
|
|
]
|
|
|
|
@margin-note{Note: This is a note. Let's make it long enough that the
|
|
markdown output will have to line-wrap, to make sure the > mark starts
|
|
each line properly.}
|