Skip to content

justinyanme/Revue_to_md

Repository files navigation

Revue_to_md

Export your Revue issues to Markdown files.

  • ✅Save the result as data.json
  • ✅Export all issues in Markdown format
  • ✅Export all subscribers to subscribers.json
  • ✅Auto download all images

简体中文请点这里

⚠️Prerequisites

Revue API TOKEN is needed for this project to run.

You can find your API token at the bottom of: getrevue.co/app/integrations.

Installation

  1. Install
git clone [email protected]:justinyanme/Revue_to_md.git
cd Revue_to_md
npm install
  1. Copy and Edit config.json
cp config.sample.json config.json
vi config.json

replace <your-revue-api-token> with your token.

{
    "log": {
        "level": "info",
        "hostname": "R2MD"
    },
    "revue": {
        "token": "<your-revue-api-token>"
    }
}

Usage

Build before run.

npm run build

You're all set! Just run the command: node built/index.js

node built/index.js

index <cmd> [args]

Commands:
  index listIssues  List all issues from revue
  index saveInMD    Save all issues in markdown format
  index exportSubscriberList  Export all subscribers to out/subscribers.json

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

If you wanna download all images the issues included, just run with -i:

node built/index.js saveInMD -i

All files are stored at the out directory in the project root path.

About

Export your Revue issues to Markdown files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published