{
    "mode": "ri",
    "parameter": "RDoc::Markdown",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/ri/RDoc%3A%3AMarkdown/json",
    "generated": "2026-06-02T16:03:08Z",
    "sections": {
        "RDoc::Markdown < Object": {
            "content": "(from gem rdoc-7.2.0)\n------------------------------------------------------------------------\nRDoc::Markdown as described by the markdown syntax(\nhttp://daringfireball.net/projects/markdown/syntax ).\nTo choose Markdown as your only default format see\nRDoc::Options@Saved+Options for instructions on setting up a\n.rdocoptions\nfile to store your project default.",
            "subsections": [
                {
                    "name": "Usage",
                    "content": "Here is a brief example of using this parse to read a markdown file by\nhand.\ndata = File.read(\"README.md\")\nformatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)\nhtml = RDoc::Markdown.parse(data).accept(formatter)\n\n# do something with html\n"
                },
                {
                    "name": "Extensions",
                    "content": "The following markdown extensions are supported by the parser, but not\nall\nare used in RDoc output by default.\n=== RDoc\nThe RDoc Markdown parser has the following built-in behaviors that\ncannot be\ndisabled.\nUnderscores embedded in words are never interpreted as emphasis. (While\nthe\nmarkdown dingus( http://daringfireball.net/projects/markdown/dingus )\nemphasizes in-word underscores, neither the\nMarkdown syntax nor MarkdownTest mention this behavior.)\nFor HTML output, RDoc always auto-links bare URLs.\n=== Break on Newline\nThe breakonnewline extension converts all newlines into hard line\nbreaks\nas in Github Flavored Markdown( https://github.github.com/gfm/ ). This\nextension is disabled by\ndefault.\n=== CSS\nThe #css extension enables CSS blocks to be included in the output, but\nthey\nare not used for any built-in RDoc output format. This extension is\ndisabled\nby default.\nExample:\n<style type=\"text/css\">\nh1 { font-size: 3em }\n</style>\n\n=== Definition Lists\nThe definitionlists extension allows definition lists using the PHP\nMarkdown Extra syntax(\nhttps://michelf.ca/projects/php-markdown/extra/#def-list ), but only one\nlabel and definition are supported\nat this time. This extension is enabled by default.\nExample:\ncat\n:   A small furry mammal\nthat seems to sleep a lot\n\nant\n:   A little insect that is known\nto enjoy picnics\n\n\nProduces:\ncat:\nA small furry mammal\nthat seems to sleep a lot\n\nant:\nA little insect that is known\nto enjoy picnics\n\n=== Strike\nExample:\nThis is ~~striked~~.\n\nProduces:\nThis is ~striked~.\n=== Github\nThe #github extension enables a partial set of Github Flavored Markdown(\nhttps://github.github.com/gfm/ ). This extension is enabled by default.\nSupported github extensions include:\n==== Fenced code blocks\nUse ``` around a block of code instead of indenting it four spaces.\n==== Syntax highlighting\nUse ``` ruby as the start of a code fence to add syntax highlighting.\n(Currently only ruby syntax is supported).\n=== HTML\nEnables raw HTML to be included in the output. This extension is enabled\nby\ndefault.\nExample:\n<table>\n...\n</table>\n\n=== Notes\nThe #notes extension enables footnote support. This extension is enabled\nby\ndefault.\nExample:\nHere is some text[^1] including an inline footnote ^[for short footnotes]\n\n...\n\n[^1]: With the footnote text down at the bottom\n\nProduces:\nHere is some text*1( rdoc-label:foottext-1:footmark-1 ) including an\ninline footnote *2( rdoc-label:foottext-2:footmark-2 )"
                },
                {
                    "name": "Limitations",
                    "content": "* Link titles are not used\n* Footnotes are collapsed into a single paragraph"
                },
                {
                    "name": "Author",
                    "content": "This markdown parser is a port to kpeg from peg-markdown(\nhttps://github.com/jgm/peg-markdown ) by\nJohn MacFarlane.\nIt is used under the MIT license:\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy\nof this software and associated documentation files (the \"Software\"), to\ndeal\nin the Software without restriction, including without limitation the\nrights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or\nsell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\nThe above copyright notice and this permission notice shall be included\nin\nall copies or substantial portions of the Software.\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL\nTHE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\nIN\nTHE SOFTWARE.\nThe port to kpeg was performed by Eric Hodel and Evan Phoenix\n------------------------------------------------------------------------\n^1( rdoc-label:footmark-1:foottext-1 ) With the footnote text down at\nthe bottom\n^2( rdoc-label:footmark-2:foottext-2 ) for short footnotes\n------------------------------------------------------------------------"
                }
            ]
        },
        "Constants:": {
            "content": "DEFAULTEXTENSIONS:\nExtensions enabled by default\n\nEXTENSIONS:\nSupported extensions\n\nHTMLENTITIES:\nHTML entity name map for RDoc::Markdown\n\n",
            "subsections": []
        },
        "Class methods:": {
            "content": "extension\nnew\nparse\n",
            "subsections": []
        },
        "Instance methods:": {
            "content": "breakonnewline\ncode\ncss\ndefinitionlists\nemphasis\nextension\nextension?\ngithub\nhtml\nlinkto\nlistitemfrom\nnote\nnotefor\nnotes\noriginitialize\nparagraph\nparse\nparsecellinline\nparsetablecells\npegparse\nrdocescape\nrdoclinkurlescape\nreference\nstrike\nstrong\n",
            "subsections": []
        }
    },
    "flags": [],
    "examples": [],
    "see_also": []
}