Commit Graph

6 Commits

Author SHA1 Message Date
Eli Barzilay
bba5d06448 Remove some redundant "www."s.
original commit: ef0f610ca73207fe661994677129d456493e47f9
2013-04-28 12:53:07 -04:00
Greg Hendershott
3f1ebb9565 Fix problem handling examples and interaction.
Unlike plain `racketblock`, `examples` and `interaction` are
"nested". As a result we emitted bad Markdown like:

    ```racket
    Examples:
    ```racket
    some-code
    ```
    ```

Markdown code blocks can't nest, so this needs to be:

    ```racket
    Examples:
    some-code
    ```

Also: Updated the unit test with examples of `examples` and
`interaction`.

original commit: a5f6686270239484a5e7b2e6864c9bd5627d937d
2013-03-29 07:23:49 -06:00
Greg Hendershott
77b1b267b5 Fix bug with pound signs used to mark sections.
Also update tests/scribble/markdown-docs files accordingly.

original commit: faeba879e292414dd6d5d9e38d4a08b26e63cceb
2012-12-19 19:32:00 -07:00
Greg Hendershott
624b8ef7e4 Render Scribble margin-note as Markdown block-quote.
More precisely, do this for nested flows with the "refcontent" style.

For instance this Scribble:

    @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.}

Will render as this Markdown:

    > 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.

A site like GitHub.com will render this in a block-quote style
suitable for notes:

> 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.

original commit: a3800cdc94d5f0c1b361d6e3ead6c1ebceb66288
2012-12-19 19:31:15 -07:00
Greg Hendershott
cdc89f9685 Render @hyperlink in Markdown.
Render Scribble like

    @hyperlink["url" "content"]

as Markdown like

    [content](url)

Note that this only works for `@hyperlink`. The motivation is to
preserve content the author has explicitly written. (Previously,
`markdown-render.rkt` was discarding this; `text-render.rkt` still
does so.)

This does _not_ attempt to handle everything that `html-render.rkt`
would automatically generate and render as `<a>`. It simply can't --
things like hotlinked Racket keywords in code blocks simply won't work
in Markdown.

original commit: dbffc840a93ceb142c59df4a533ced0b41b8e4fa
2012-12-11 12:40:54 -07:00
Greg Hendershott
51d487bc1b Add a Markdown rendering mode to Scribble.
Uses "Github flavored markdown". Specifically, code blocks are opened
using ```scheme so that Github will lex and format them as Scheme code
rather than generic monospace.

Note: I would have used ```racket, but we are still waiting for the
pygments.rb project to pull again from pygments-main -- to which I
contributed a Racket lexer back in August. After pygments.rb pulls,
can update this to use ```racket instead.

original commit: 6aa6dc0400f4fed688e6f5b5278da2e34d82ad88
2012-12-09 15:17:36 -07:00