https://github.com/siyabuilds/md-to-docx
https://github.com/siyabuilds/md-to-docx
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/siyabuilds/md-to-docx
- Owner: siyabuilds
- Created: 2026-05-13T10:06:50.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-20T08:36:29.000Z (29 days ago)
- Last Synced: 2026-05-20T12:25:41.040Z (29 days ago)
- Language: Shell
- Size: 7.81 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# md-to-docx
Convert markdown files in a folder to `.docx` using `pandoc`.
## Prerequisite
- [pandoc](https://pandoc.org/) must be installed and available in your `PATH`.
## Installation (Optional)
To make `run-convert` available globally across all directories, use the provided install script:
```bash
chmod +x install.sh
./install.sh
```
If you already have `run-convert` installed and need to update it with latest changes, you can use the `-u` override flag:
```bash
./install.sh -u
```
The script will copy `run-convert` to `~/.local/bin` and automatically add that directory to your `$PATH` (in `.bashrc` and `.zshrc`).
After installation, reload your terminal configuration (e.g., run `source ~/.bashrc` or `source ~/.zshrc`) to apply the changes.
## Usage
```bash
run-convert [target_directory]
```
If no `target_directory` is specified, it defaults to the current directory (`.`).
### Features
- **Recursive Processing**: Finds all `.md` and `.markdown` files (case-insensitive) in the target directory and its subdirectories.
- **Organized Output**: Saves all generated `.docx` files into a `word/` subdirectory within the target directory.
- **Smart Naming**: Files named `index.md` or `_index.md` are automatically named after their parent directory instead of "index".
- **Custom Font**: Applies "Poppins" as the main font for the generated Word documents.