zenn2press 0.1.0

A Rust library to convert Zenn contents to VitePress
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# zenn2press

![Crates.io Version](https://img.shields.io/crates/v/zenn2press)
[![Test Suite](https://github.com/ryohidaka/zenn2press-rs/actions/workflows/test.yml/badge.svg)](https://github.com/ryohidaka/zenn2press-rs/actions/workflows/test.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

`zenn2press` is a Rust library to convert Zenn contents to VitePress.

## Features

### `copy_markdown_files()`

Copy Markdown files from a source directory to a destination directory with options to include or exclude specific files.

### `copy_images()`

Copy image files from a source directory to a destination directory, also with options to include or exclude specific files.

## Installation

Add zenn2press to your `Cargo.toml`:

```toml
[dependencies]
zenn2press = "0.1.0"
```

## Usage

### CLI

Here is an example of how to use zenn2press with cli:

```sh
zenn2press --help

zenn2press \
    -s zenn \
    -c config.json \
    -d press/docs/articles \
    -m press/docs/public/images \
    -i sample-article-1
```

#### Parameters

| Argument          | Short | Long                | Value Name | Description                                                                                               |
| ----------------- | ----- | ------------------- | ---------- | --------------------------------------------------------------------------------------------------------- |
| `src_dir`         | `-s`  | `--src-dir`         | `DIR`      | Path of the root directory of Zenn content.                                                               |
| `dest_dir`        | `-d`  | `--dest-dir`        | `DIR`      | The VitePress directory path (e.g. `docs/entries`) where you want to place the markdown for the articles. |
| `dest_images_dir` | `-m`  | `--dest-images-dir` | `DIR`      | The VitePress directory path (e.g. `public`) where the image will be placed.                              |
| `config_file`     | `-c`  | `--config-file`     | `FILE`     | Configuration file path.                                                                                  |
| `include`         | `-i`  | `--include`         | `<FILE>`   | File names to include, separated by commas.                                                               |
| `exclude`         | `-e`  | `--exclude`         | `<FILE>`   | File names to exclude, separated by commas.                                                               |

### Package

Here is an example of how to use zenn2press in your project:

```rust
use zenn2press::{copy_images, copy_markdown_files};

#[tokio::main]
async fn main() {
    let src_dir = "demo/zenn/articles";
    let dest_dir = "demo/press/docs/articles";
    let config_file = Some("demo/zenn2press-config.json");
    let include = Some(vec!["sample-article-1"]);
    let exclude = None;

    // Copy markdown files from srcDir to destDir using properties
    copy_markdown_files(
        src_dir,
        dest_dir,
        config_file,
        include,
        exclude
    )
    .unwrap_or_else(|e| {
        eprintln!("Error copying markdown files: {}", e);
    });

    // Copy images from srcDir to destDir using properties
    match copy_images(
        "demo/zenn/images",
        "demo/press/docs/public/images",
        include,
        exclude
    )
    .await
    {
        Ok(_) => println!("Images copied successfully."),
        Err(e) => eprintln!("Error copying images: {}", e),
    }
}
```

### Config file (`Optional`)

**zenn2press-config.json**

```json
{
  "frontmatter": {
    "aside": true,
    "editLink": true,
    "footer": true,
    "lastUpdated": true,
    "layout": "doc",
    "navbar": true,
    "outline": [1, 2, 3],
    "sidebar": true,
    "titleTemplate": ":title - Custom Suffix"
  }
}
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.