This repository contains an automatic conversion of the FreeCAD wiki located at https://wiki.freecadweb.org to markdown format. The conversion is done automatically through the migrate.py script located within this repository. The script downloads the wiki contents in XML format using the MediaWiki API and uses pandoc to convert between mediawiki and markdown formats.
The general idea is to keep allowing users to use the wiki to edit and add contents, while the markdown format for:
- Better handling of the documentation within FreeCAD, have the ability to code an own help viewer better than the QAssistant viewer currently in use
- Allow to use either an online or an offline version of the documentation
- Automatic and easier backups, same as the FreeCAD source code
- Better versioning and matching to FreeCAD versions
- Better handling of translations
Further goals:
- Create a Help workbench with a md viewer
- QTextDocument supports markdown (but might be problems with online images)
- Maybe better to use an HTML viewer and convert the markdown content?
- Allow the help workbench to access both online or offline (local files) versions
- Allow the help workbench to access any translated version
- Tie the FreeCAD help system to the Help workbench
- Tie the FreeCAD what's this system to the Help workbench
- Allow to export parts of the documentation to other formats (PDF, ePub,...)