# @vivgui/markdown-backup

> Download remote images in markdown files and store them locally

Latest version **2.0.1** (published 2023-02-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vivgui/markdown-backup
pnpm add @vivgui/markdown-backup
yarn add @vivgui/markdown-backup
bun add @vivgui/markdown-backup
```

Provides the command `markdown-backup`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2023-02-16 |
| First published | 2023-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vivian Guillen |
| Maintainers | vivgui |

## Links

- npm: https://www.npmjs.com/package/@vivgui/markdown-backup
- Repository: https://github.com/gunar/markdown-backup
- Homepage: https://github.com/gunar/markdown-backup#readme
- Issues: https://github.com/gunar/markdown-backup/issues
- npm.io page: https://npm.io/package/@vivgui/markdown-backup

## Dependencies (4)

- [glob](https://npm.io/package/glob.md) ^7.1.4
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [markdown-parser](https://npm.io/package/markdown-parser.md) 0.0.8
- [string-replace-async](https://npm.io/package/string-replace-async.md) ^2.0.0

## Recent versions

- 2.0.1 (latest) — 2023-02-16

## README

# markdown-backup

[![NPM](https://nodei.co/npm/markdown-backup.png?compact=true)](https://npmjs.org/package/markdown-backup)

Download remote images in markdown files and store them locally.

Images are stored in an `images` directory created by the tool itself.

**This application mutates your existing files.** Make sure to backup your files before giving it a go. I'm not resposible for loss of data. Take care and be well my friend.

There's a [guide on how to use it to with roam-to-git](#roam-to-git)


## Example

```
$ tree test
test
└── test.md

0 directories, 1 file

$ cat test/test.md
# markdown-backup
![alt](https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png)

$ markdown-backup.js "test/*.md"
File path: test/*.md
Processing: test/test.md
Downloading: https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png
Done!

$ tree test
test
├── images
│   └── 0.png
└── test.md

1 directory, 2 files

$ cat test/test.md
# markdown-backup
![alt](./images/0.png)
```

## Install

```
$ npm install -g markdown-backup
```

## Use

```
$ markdown-backup "**/*.md"
```

## [roam-to-git](https://github.com/MatthieuBizien/roam-to-git)

Add `markdown-download` after the `Run backup` step in `.github/workflows/main.yml`.

Should look like this:

```yaml
name: "Roam Research backup"

on:
  push:
    branches:
      - master
  schedule:
    -   cron: "0 0 * * *"

jobs:
  backup:
    runs-on: ubuntu-latest
    name: Backup
    timeout-minutes: 15
    steps:
      -   uses: actions/checkout@v2
      -   name: Set up Python 3.8
          uses: actions/setup-python@v1
          with:
            python-version: 3.8
      -   name: Install Python dependencies
          run: pip install git+https://github.com/MatthieuBizien/roam-to-git.git
      -   name: Set up Node
          uses: actions/setup-node@v2-beta
      -   name: Run backup
          run: roam-to-git --skip-git .
          env:
            ROAMRESEARCH_USER: ${{ secrets.ROAMRESEARCH_USER }}
            ROAMRESEARCH_PASSWORD: ${{ secrets.ROAMRESEARCH_PASSWORD }}
            ROAMRESEARCH_DATABASE: ${{ secrets.ROAMRESEARCH_DATABASE }}
      -   name: Download markdown images
          run: npx markdown-backup "markdown/**/*.md"
      -   name: Commit changes
          uses: elstudio/actions-js-build/commit@v3
          with:
            commitMessage: Automated snapshot
```

---
_Source: https://npm.io/package/@vivgui/markdown-backup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._