https://github.com/Zerokei/TextConverter

A tool to convert text from obsidian markdown format into mkdocs markfown format.
https://github.com/Zerokei/TextConverter

Last synced: about 2 months ago
JSON representation

A tool to convert text from obsidian markdown format into mkdocs markfown format.

• Host: GitHub
• URL: https://github.com/Zerokei/TextConverter
• Owner: Zerokei
• Archived: true
• Created: 2022-08-18T02:41:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-03T01:30:09.000Z (over 2 years ago)
• Last Synced: 2024-08-08T00:43:55.433Z (5 months ago)
• Language: Python
• Homepage:
• Size: 60 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - Zerokei/TextConverter - A tool to convert text from obsidian markdown format into mkdocs markfown format. (Python)

README

        
# TextConverter :curly_loop:

## Introduction

Obsidian is a markdown-based notes software, while MkDocs is a markdown-based content distribution platform. However, it is well known that markdown has quite a bit of **extended syntax** beyond the base standard. Plus Obsidian and MkDocs both have their own plugins. So, to do content **migration** in both software, sometimes you need to do some content modification.

![](img/p1.png)

## Features

### 1. Obsidian Admonition -> MkDocs Admonition

For the Obsidian admonition, the syntax is

````markdown

```ad-info

xxx

```

```` 

For the MkDocs admonition, the syntax is 

````markdown

!!! info

    xxx

````

![](img/admonition.png)

### 2. Erase tags

In obsidian, you may add several tags, but in MkDocs, they are not rendered.

### 3. Resort footnotes

In MkDocs, the footnotes are ordered in the same order as at the end of the markdown file, and for aesthetic purposes should be ordered according to the order in which they appear in the text.

## Usage

```bash

$ git clone [email protected]:Zerokei/TextConverter.git

$ python3 src/main.py target_path # the target path stores the markdown files

```