https://github.com/ryohidaka/zenn2press-rs
A Rust library to convert Zenn contents to VitePress.
https://github.com/ryohidaka/zenn2press-rs
cli markdown vitepress zenn
Last synced: 4 months ago
JSON representation
A Rust library to convert Zenn contents to VitePress.
- Host: GitHub
- URL: https://github.com/ryohidaka/zenn2press-rs
- Owner: ryohidaka
- License: mit
- Created: 2024-08-04T05:34:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T06:00:11.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T01:40:37.527Z (about 1 year ago)
- Topics: cli, markdown, vitepress, zenn
- Language: Rust
- Homepage: https://crates.io/crates/zenn2press
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# zenn2press
[](https://github.com/ryohidaka/zenn2press-rs/actions/workflows/test.yml)
[](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 names to include, separated by commas. |
| `exclude` | `-e` | `--exclude` | `` | 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.