MDX is a custom prototype markdown extension format where custom data can be added to regular markdown tags. It aims to give a little extra control over the structure and function of markdown files by allowing you to add a variety of elements. The main focus of MDX is for converting content into HTML format.
It's still pretty (very) rough around the edges. See the files sample.mdx and sample.html for some examples.
If you wish to use MDX as a command line tool for generating HTML files.
Add MDX to your Go project by running
go get https://github.com/mjbozo/mdx
After importing MDX into your Go project, you can generate HTML files by calling the Generate() method, and passing
it an appropriate config object. The config option must have InputFilename data, and can optionally have other data
such as:
- Title
- InputFilename
- OutputFilename
- Links
See the sample example to see how MDX-HTML generation can be used.
You can also use MDX in conjuction with Go's templating system to insert formatted HTML into targetted areas of a
template file. Calling the Transform() method will return the HTML string that was transformed from the MDX.
See the template example to see how MDX-HTML transformation can be used.
To add more customisability to markdown, MDX features properties. By prefixing elements with name/value properties
wrapped in { }, the subsequent parsed elements will receive these properties when parsed into HTML.
Example:
{ .class=section-heading }
# WelcomeTo add more structure, divs can be parsed into the HTML by wrapping content in [ ]. Combining divs with properties
allows for much more control over the styling and structure of the resulting HTML.
Example:
[
# Welcome
Hello there
]For inline structure, spans can be parsed by wrapping content in $ $. Combining spans with properties is also a
powerful way of managing inline styling.
Example:
Hello, $ world $!For adding interactivity, buttons can also be added with the syntax ~[x](y), where x is the button label, and y is
the name of the click handler function defined in the HTML script tag. Still figuring out a good way to get code in the
script tags.
Example:
~[Click Me](handleClick)This one generates some very specific styling for a particular use case, and is the catalsyst for MDX being created.
To generate the custom code block, wrap the code in ^^ ^^. Syntax highlighting is not supported but hopefully will be
in the future.
Example:
^^
func main() {
fmt.Println("Hello, world!")
}
^^While not entirely useful since we already have divs and custom properties, Nav elements are supported anyways. You can
generate a Nav element by wrapping the content in @ @.
Example:
@
[Home](/home)
[Feed](/feed)
[Account](/account)
@Yes, markdown already supports comments, but I prefer commenting a line by prefixing it with //, so that's what I've
done here.
Example:
// do you really need an example for this one?TODO :P