racket/collects/tests/scribble/markdown-docs/example.scrbl
Greg Hendershott faeba879e2 Fix bug with pound signs used to mark sections.
Also update tests/scribble/markdown-docs files accordingly.
2012-12-19 19:32:00 -07:00

79 lines
1.8 KiB
Racket

#lang scribble/doc
@(require scribble/manual
(for-label racket/base racket/contract racket/string))
@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://www.racket-lang.org/" "I am a hyperlink to Racket."]
@italic{Italic}.
_Just underlines_.
@bold{Bold}.
*Just asterisks.*
``Dobule quoted''.
`Single quoted'.
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]
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]
}
@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.}