An open API service indexing awesome lists of open source software.

https://github.com/alswl/yuque2markdown

yuque2markdown convert your Yuque export file(.lakebook) to markdown files
https://github.com/alswl/yuque2markdown

yuque

Last synced: 5 months ago
JSON representation

yuque2markdown convert your Yuque export file(.lakebook) to markdown files

Awesome Lists containing this project

README

          

# yuque-to-markdown

> status: it works

Simple convertor, it converts `.lakebook` to markdown files, and all the outputs is in `markdown` format.
The structure of the output folder is the same as the structure of the book in yuque.

## How to install

```bash
# Make sure your Python3 is installed
python3 -V

# Clone this repo
git clone git@github.com:alswl/yuque2markdown.git
cd yuque2markdown

# Install packages
pip3 install -r requirements.txt
```

## How to use

1. Go to your yuque book configuration page, click `设置` button
2. Click `导出` button, and download the `.lakebook` file
3. Using this tool to convert it to markdown files

```bash
python3 yuque2markdown.py /path/to/your/lakebook/file.lakefile /path/to/your/output/folder --download-image

# show your converted files
tree /path/to/your/output/folder
```

CLI Description:

```shell
python yuque2markdown.py --help
usage: yuque2markdown.py [-h] [--download-image] lakebook output

Convert Yuque doc to markdown

positional arguments:
lakebook Lakebook file
output Output directory

options:
-h, --help show this help message and exit
--download-image Download images to local
```

## Contributors