[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Development Ideas for MediaGoblin's Docs

From: Distopico Vegan
Subject: Re: Development Ideas for MediaGoblin's Docs
Date: Sat, 24 Apr 2021 22:14:32 -0500

Mediagoblin use sphinx and it support markdown as well and sphinx is
more powerful than mkdocs, I don't believe that reStructuredText is a
barrier to the contributor in the end both formats have similar
structure and many editor also support .rest, maybe for a non dev/tech
contributor the wiki could be easier so I think could be better
put the effort to restoring the wiki than migrate the docs to another

On 2021-04-24, jgart wrote:

> Hi Goblineers, 
> What do you think of mediagoblin having markdown for its docs in the future 
> instead of reStructuredText? 
> I was thinking of using MkDocs: 
> My motivation for having having mediagoblin's docs in markdown is for reasons 
> of accessibility. New contributors or those not familiar with reST will more 
> than likely feel more comfortable making contributions to mediagoblin docs if 
> they were written in markdown. 
> Most text editors also support markdown syntax so it's likely that a beginner 
> would have a higher probabability of easily finding support for markdown and 
> not run into as many issues. 
> Markdown can also be easily previewed in a web browser. It's not as easy to 
> find reST previewers/renderers.
> 11.2k projects depend on MkDocs on github alone.
> It would be quite easy to convert the mediagoblin codebase to markdown with 
> pandoc. 
> What do you think?
> jgart
> ps
> I'm working on packaging MkDocs for guix. I'll let you know as soon as it's 
> merged upstream.

Attachment: signature.asc
Description: PGP signature

reply via email to

[Prev in Thread] Current Thread [Next in Thread]