{"repo":"readmeio/markdown","free":true,"listed":false,"github":"https://github.com/readmeio/markdown","clone":"git clone https://github.com/readmeio/markdown.git","description":"ReadMe's flavored Markdown parser and React-based rendering engine.","language":"TypeScript","stars":41,"topics":["markdown","react","gfm","mdx","rdmd"],"license":"ISC","category":"api-integrations-sdks","readme_excerpt":"ReadMe's MDX rendering engine and custom component collection. Use ReadMe? Learn more about our upcoming move to MDX! Usage To use the engine, install it from NPM: Then compile and run your MDX: API compile Compiles MDX to JS. Essentially a wrapper around mdx.compile . Used before calling run ; it has been left as a seperate method for potential caching opportunities. Parameters - string ( string )—an MDX document - opts ( CompileOpts , optional)—a configuration object Returns A string of compiled Javascript module code. run [!CAUTION] This is essentially a wrapper around mdx.run and it will eval the compiled MDX . Make sure you only call run on safe syntax from a trusted author! Parameters - string ( string )—a compiled mdx document - opts ( RunOpts , optional)—configuration Returns An RMDXModule of renderable components. mdx Compiles an AST to a string of MDX syntax. Parameters - tree ( object )—an abstract syntax tree - opts ( Options )— remark-stringify configuration. Returns An MDX string. Other Methods - mdast : parse MDX syntax to MDAST. - hast : parse MDX syntax to HAST. - plain : parse MDX to a plaintext string with all Markdown syntax removed. (This does not eval the doc.) - tags : get a list of tag names from the doc. (This does not eval the doc.) - utils : additional defaults, helper methods, components, and so on. Types CompileOpts Extends CompileOptions Additional Properties - lazyImages ( boolean , optional)—load images lazily - safeMode ( boolean , optional)—e","default_branch":null,"files":null,"tree":[],"storefront":"/r/readmeio","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/readmeio/markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}