# Converting GitHub markdown to MediaWiki articles

**URL:** <https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477>\
**Category:** Development\
**Created:** [May 31, 2022, 2:00am UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477 "2022-05-31T02:00:41Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![emyoulation](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/emyoulation/32/67_2.png) [@emyoulation](https://gramps.discourse.group/u/emyoulation)\
**Post date:** [May 31, 2022, 2:00am UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/1 "2022-05-31T02:00:41Z")

</div>

Is there a preferred tool & workflow for converting add-on development `README.md` files in a GitHub repository to make a preliminary MediaWiki webpage for a new add-on?

(I accept that we’re still limited by our MediaWiki backend failing to properly update. So we shouldn’t risk installing add-ons like a bulk image uploader.)

It is unfortunate that GitHub markdown is a foreign format for the desktop OSes. Otherwise, the development documentation files that get ZIPped up with the add-on could simply become the initial fallback documentation. The Help (or a [Python Markdown](https://github.com/topics/python-markdown) Viewer tool made into a Gramplet) would just look for the local `README.md` file.

* * *

The following tool was found on an unfamiliar domain: AllDocs.app – [Convert Markdown (GitHub) Input format to MediaWiki](https://alldocs.app/convert-markdown-to-mediawiki-markup)

 ![image](https://global.discourse-cdn.com/free1/uploads/gramps/original/2X/e/ec97c851962f6ca360147f72c696aff84b55633f.png)

---

<div class="post-metadata">

**Author:** ![emyoulation](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/emyoulation/32/67_2.png) [@emyoulation](https://gramps.discourse.group/u/emyoulation)\
**Post date:** [May 31, 2022, 2:10am UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/2 "2022-05-31T02:10:52Z")

</div>

A few years ago, we built a [“How do I?” template](https://gramps-project.org/wiki/index.php/Template:How_do_I) that inserted a skeletal framework for writing tutorial articles on the wiki.

All a WikiContributor had to do was paste the following line into a new blank page, save it, and the skeleton (with cut&paste ready example elements) would be flowed into the article.  
`{{subst:Template:How_do_I}}`

I wanted to build a similar template for Addons. (Technically, the templates are straight-forward.) But never was able to put together a nice standard layout for the content… suffering from writer’s block.

---

<div class="post-metadata">

**Author:** ![StoltHD](https://avatars.discourse-cdn.com/v4/letter/s/db5fbb/32.png) [@StoltHD](https://gramps.discourse.group/u/StoltHD)\
**Post date:** [May 31, 2022, 12:49pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/3 "2022-05-31T12:49:02Z")

</div>

You can use Pandoc for that.

---

<div class="post-metadata">

**Author:** ![ennoborg](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/ennoborg/32/4659_2.png) [@ennoborg](https://gramps.discourse.group/u/ennoborg)\
**Post date:** [May 31, 2022, 1:36pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/4 "2022-05-31T13:36:51Z")

</div>

A quick search on Google reveals that there are Markdown plugins for Chrome and Firefox.

---

<div class="post-metadata">

**Author:** ![emyoulation](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/emyoulation/32/67_2.png) [@emyoulation](https://gramps.discourse.group/u/emyoulation)\
**Post date:** [May 31, 2022, 2:12pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/5 "2022-05-31T14:12:38Z")

</div>

> [@ennoborg](#):
>
> there are Markdown plugins for…

That’s true and a good thing.

But reading intro documentation should not be reliant on an optional prerequisite. It should either be a standard in all the supported OSes or a built-in for Gramps.

The GitHub server automatically renders READMD.md files as basic HTML. So pre-processing is how they get away with a non-universal format.

---

<div class="post-metadata">

**Author:** ![ennoborg](https://yyz2.discourse-cdn.com/free1/user_avatar/gramps.discourse.group/ennoborg/32/4659_2.png) [@ennoborg](https://gramps.discourse.group/u/ennoborg)\
**Post date:** [May 31, 2022, 6:13pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/6 "2022-05-31T18:13:33Z")

</div>

True. An alternative path would be to let our help point to Add-On documentation on GitHub instead, because in that case, it will be presented in the right format right away.

---

<div class="post-metadata">

**Author:** ![StoltHD](https://avatars.discourse-cdn.com/v4/letter/s/db5fbb/32.png) [@StoltHD](https://gramps.discourse.group/u/StoltHD)\
**Post date:** [June 13, 2022, 2:14pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/7 "2022-06-13T14:14:10Z")

</div>

Here are a couple of tools I found, maybe you can find use of one of them…  
Not Python.

- [GitHub - yakivmospan/github-wikito-converter: Generate HTML & PDF documentation from Github wiki or any other markdown-based wiki.](https://github.com/yakivmospan/github-wikito-converter)
- [GitHub - limedocs/limedocs-wiki-converter: Generate HTML & PDF documentation from you Github wiki or any other markdown-based wiki](https://github.com/limedocs/limedocs-wiki-converter)

Here are an article:

> **[How to Transition from Github Wiki to Mediawiki](https://revelrylabs.github.io/development/growth/2015/12/03/how-to-transition-from-github-wiki-to-mediawiki/)**
>
> Convert from Github Wiki to Mediawiki in 10 not-so-easy steps!

and this is a gist with how to do it with pandoc:

> <https://gist.github.com/mkweskin/5414303>

---

<div class="post-metadata">

**Author:** ![system](https://global.discourse-cdn.com/free1/uploads/gramps/original/1X/2ac1e712b7adf612e31ca08a55419f4cf37c0158.png) [@system](https://gramps.discourse.group/u/system)\
**Post date:** [July 13, 2022, 2:14pm UTC](https://gramps.discourse.group/t/converting-github-markdown-to-mediawiki-articles/2477/8 "2022-07-13T14:14:11Z")

</div>

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.
