Mdx Markdown
- Mdx Markdown Syntax
- GitHub - Mdx-js/mdx: JSX In Markdown For Ambitious Projects
- Markdown Syntax | Gatsby
- See Full List On Github.com
- Mdx Markdown Manager
You write your slides in Markdown and sprinkle in other nice bits around what you’re saying in the slide, you know like most presentations. I made a couple of presentations using MDX Deck. In it’s simplest form this is what a presentation can look like in Markdown using MDX, the. Provides syntax highlighting and bracket matching for MDX (JSX in Markdown) files. Installation Launch VS Code Quick Open ( Ctrl+P ), paste the following command, and press enter.
Released:
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy linebreaks.
Project description
An extension for Python-Markdown that makes lists truly sane. Features custom indents for nested lists and fix for messy linebreaks and paragraphs between lists.
Features
nested_indent
option: Custom indent for nested lists. Defaults to2
. Doesn't mess with code indents, which is still 4.truly_sane
option: Makes linebreaks and paragraphs in lists behave as usually expected by user. No longer adds weirdp
, no extra linebreaks, no longer fuses lists together when they shouldn't be fused (see screenshots and examples below). Defaults toTrue
.Inherits sane lists behavior, which doesn't allow the mixing of ordered and unordered lists.
Installation
Pypi:
Directly from git:
Usage
Basic:
With explicit config:
Screenshots and examples
You can preview the new behaviour live at rentry.co (uses nested_indent: 2, truly_sane: True
)
Some ugly screenshots because I'm lazy and cannot into gimp:
HTML
Data:
No extension:
Truly sane + 4 spaces:
Release historyRelease notifications | RSS feed
1.2
1.1.1
1.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size mdx_truly_sane_lists-1.2-py3-none-any.whl (5.0 kB) | File type Wheel | Python version py3 | Upload date | Hashes |
Filename, size mdx_truly_sane_lists-1.2.tar.gz (4.5 kB) | File type Source | Python version None | Upload date | Hashes |
Hashes for mdx_truly_sane_lists-1.2-py3-none-any.whl
Algorithm | Hash digest |
---|---|
SHA256 | cc8bfa00f331403504e12377a9c94e6b40fc7db031e283316baeeeeac68f1da9 |
MD5 | ff146e0ce7d4e5abce9bd554e1fef792 |
BLAKE2-256 | 05d850d108921125389b2853aab2a93a1dbcf469b52f2f8521bcf6a2410cc6e5 |
Hashes for mdx_truly_sane_lists-1.2.tar.gz
Algorithm | Hash digest |
---|---|
SHA256 | 4600ade0fbd452db8233e25d644b62f59b2798e40595ea2e1923e29bc40c5b98 |
MD5 | bd9abadda506e80633b926bccb41f2b3 |
BLAKE2-256 | 2694a3f574c8e33072f96221e4524f476437b187c8a7f616f3e95f59f5f5ee13 |
Ever since I first saw Sara Vieira’s slides form Vue London 2018I’ve really liked the idea of writing a presentation in MDX.
Sara used something called MDX Deck and it’s pretty dope! You writeyour slides in Markdown and sprinkle in other nice bits around whatyou’re saying in the slide, you know like most presentations. I made acouple of presentations using MDX Deck.
In it’s simplest form this is what a presentation can look like inMarkdown using MDX, the ---
indicates the separator for the slides.
Mdx Markdown Syntax
I’ve tried several other solutions along the way, here they arelisted:
- MDX Deck
- Gatsby Theme MDX Deck
- Untested by me but I did find MDX Vue Deck
The first two are the same really with using Gatsby shadowing (theme)for MDX Deck in Gatsby Theme MDX Deck.
For a really good example of using MDX Deck as a theme inside of aGatsby project check out Sam Larsen-Disney’s site, sld.codes andthe presentations pages inside there. Each presentation is it’s ownMDX Deck slide deck. 🤯
The OG!
MDX Deck is the OG of these and was a bit rough around the edges tobegin with (it’s now at v4). I personally never had any joy usinganything above v1 when it came to using images in your presentations,which my presentations relied on a lot.
I used MDX Deck happily for a couple of presentations but it alwaysirked me that certain support was missing causing a lot of people towonder if it was still supported.
We get it, Jackson’s a busy guy and OSS is, well OSS. So after I waslined up to do talk about Spreading the jamstack at Scale By theBay I opted for something with a touch more features to use, this iswhen I discovered Next MDX Deck when Monica Powell did a talk atMDX conf.
Next MDX Deck
Next MDX Deck had the MDXProvider
exposed which means that I couldfold in components at a high level rather than have to import them onthe slide level.
GitHub - Mdx-js/mdx: JSX In Markdown For Ambitious Projects
This means that I can use MDX Embed and throw in Tweets, CodePensand YouTube videos to my hearts content.
In the process of me doing the slides I need to do for Tuesday Ifound I’m not the only one that procrastinates a touch when it comesto making slides for a presentation.
No doubt Sarah’s presentation is going to be 🔥
So whilst I was looking at doing my slides for the MMT Tech Meetup Idecided not to go with Next MDX Deck and went about trying to findan alternitive. See other solutions mentioned earlier on. 👍
Prerequisites
There are a few options I need in the respect of making a slidespresentation.
These are all my own preferences and by no way should define how youselect a deck for yourself. These are deal-breakers for me and myuse-cases however:
- Speaker mode, the ability to present on one screen and have yournotes on another.
- The option to add images in any format,
.SVG
,.png
, the rest. - Web publishing, people after the presentation can view themretrospectively.
- Ability to add custom components and images, a nice sprinkling ofTweets and embeds are the life blood of what can otherwise be quitea dry presentation. 😂
- Slide customisation, individual slide colours, effects, etc.
FUSUMA
First alternitive I found was FUSUMA and it wasn’t until I got intothe very important part of customisation of the slides that I foundthe Yaml file used to configure the theme and code blocks didn’t workon my setup (WSL behbeh).
Another main feature I look for is the ability to publish the slideson a CDN somewhere so I can point people to the slides after thepresentation. This was another sticking point which I couldn’t getpast so I carried on looking.
I’m sure FUSUMA is a great tool for presentations but didn’t fit withmy use-case.
MDXP
MDXP is not built in Gatsby or NextJS, it’s a plain old React app withan exposed webpack config file and all the requisite plugins forimages and Markdown + MDX.
MDXP comes with a set core of components for general use, <Note>
isgreat for presenter notes and there’s a really handy one in <Step>
that allows you to, ahem ‘step’ through certain items on one slide.
How it works
With MDXP there’s still the top level index file which is used to wrapthe rest of the application, this is where the components for theslides can be ‘folded’ in.
Here’s an example of what that could look like:
The deckComponents
are what I provide, if I wanted to only use theprovided MDXP components I could stick with just those.
The deck-components
file is where I can group all the components Iwant to use in the presentation, here I’m bringing in a customCodeHighlight
component that I can wrap code blocks in for thepresentation:
The CodeHighlight
component can then be used in the slides, justbear in mind that the component needs to wrap everything in thatslide. So if I wanted notes with the MDXP <Note>
component theycould need to be contained by <CodeHighlight>
.
I like the flexability of this because it means that the slides canhave an individual look and feel which is something that I’ve foundlacking in the alternitives.
Wrap
So, for now, I’m all in with MDXP and I’ll be looking to use it morein the future.
If you’re interested then take a look at the example MDXP slides foran idea of what it’s capable of doing.
Markdown Syntax | Gatsby
There’s also the documentation which does a great job of explainingall the available components and concepts.
See Full List On Github.com
Looks like you have reached the bottom of this page!
Bummer!
Mdx Markdown Manager
Is that two cheeky for you?!