mjmlio / mjml

MJML: the only framework that makes responsive-email easy
https://mjml.io
MIT License
17.03k stars 959 forks source link

Moving documentation from Slate to Docusaurus #2316

Open iRyusa opened 3 years ago

iRyusa commented 3 years ago

Slate doc starts to be a bit outdated and we have some part of the documentation that are not really accurate (default values, attribute list, ... ).

I know that React Native use Docusaurus and looks to be able to generate some parts of it on the fly (https://github.com/facebook/react-native-website/blob/master/sync-api-docs). We still have some missing informations in components that we have in doc (ex: description).

I don't know where it's going but I'll start a new repository with a minimal Docusaurus theme, a "Doc" page and "Components" page as RN does.


Todo (not exhaustive)

GarryFlemings commented 3 years ago

This is wonderful news! It's great this path is opening to the project.

Might the project describe the preferred final product so we can all work together?

For example:

iRyusa commented 3 years ago

It's way too early to discuss about this as we'll most likely import our current doc into docusaurus to see if we can migrate easily.

You can just check exemple on https://docusaurus.io/