Gitlab Wiki Exporter

approved

by jrabmer

Makes your entire vault Gitlab Wiki compatible and exports it to a specified location.

7 stars2,347 downloadsUpdated 8mo agoMIT

Obsidian Gitlab Wiki Converter

📖 Brief Explanation

This plugin is used to export your entire obsidian vault as a Gitlab Wiki. Because Gitlab Flavoured Markdown (GFM) and Gitlab Wikis have some unique aspects, the following actions need to be taken:

  • Replace spaces in file names with -, since Gitlab uses page slugs for links
  • Choose a file to act as your starting page. This will be renamed to home
  • Remove file endings in links for markdown files, which tells Gitlab its a wiki page and not just a file
  • Export files to specifed folder

The plugin only renames the files temporarily and no permanent changes will be made to your vault.

🔓 Prerequisites

The plugin assumes that your vault does not use WikiLinks but uses relative Paths for link formats. This may be changed in the future. Until then make sure you set Settings -> Files and links -> New Link format to Relative path to file and disable Use [[Wikilinks]].

In case you have an existing vault with WikiLinks, I personally use the following plugin by Ozan Tellioglu (with relative paths setting!).

💻 How to use

Once the plugin is loaded, the command Export Vault as Gitlab Wiki can be used to export the vault. Make sure to specify the export location and home page in the settings first!

🌄 Road Map

  • Fix line break issue on Gitlab
  • Use name with spaces instead of page slugs for links in files
  • Implement more GFM features in the future
  • Add WikiLink support

📩 Contact

If you have any issue or you have any suggestions, please feel free to reach out to me directly at jrabmer@outlook.com.

☕ Support

If you are enjoying the plugin then you can support my work and enthusiasm by buying me a coffee:

Buy Me a Coffee at ko-fi.com

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.