shodo

Shodo Python CLI


License
MIT
Install
pip install shodo==0.0.10

Documentation

Shodo Python CLI

Installation

$ pip3 install shodo

Configuration

These environment variables are required

  • SHODO_API_ROOT Root endpoint for API (like https://api.shodo.ink/@my-organization/my-project/).
  • SHODO_API_TOKEN Token to access each projects (Access to Shodo and see projects' ใ€ŒAPI้€ฃๆบใ€ settings page)

Usage

Lint Japanese. This command requires authentication (API root and a token) for Lint API projects (not for writing).

$ shodo lint filename.md
$ shodo lint ./demo/demo.md                                                                                          15:18:27
18:4 ใ‚‰ๆŠœใ่จ€่‘‰ใงใ™
     ใฆใใ ใ•ใ„ใ€‚ ใ™ใใซ้ฃŸในใ‚Œใ‚‹๏ผˆโ†’ ้ฃŸในใ‚‰ใ‚Œใ‚‹๏ผ‰ใ€‚ 
...
3:11 ใ‚‚ใ—ใ‹ใ—ใฆAI
     ้ฃ›่กŒๆฉŸใฎๆฌ ไพฟใŒใ‚ใ‚Šใ€้‹่กŒ๏ผˆโ†’ ้‹่ˆช๏ผ‰็ŠถๆณใŒๅค‰ใ‚ใฃใŸใ€‚ ใƒ
6:5 ใ‚‚ใ—ใ‹ใ—ใฆAI
     ใพใ›ใ‚“ใ€‚  ใ“ใ‚ŒใŒ็งใง๏ผˆโ†’ ใฎ๏ผ‰่‡ชๅทฑ็ดนไป‹ใงใ™ใ€‚  ใ“
12:11 ใ‚‚ใ—ใ‹ใ—ใฆAI
     ใชใ‚“ใงใ‚‚ๅ•้กŒใ‚’่งฃๆฑบใ—ใ„๏ผˆโ†’ ใƒˆใƒซ๏ผ‰ใพใ™ใ€‚ ๆ—ฅๆœฌ่ชžใฎใฎใ‚ˆ

Download files

Download all of Markdown posts and images!

$ shodo download --target=docs

Options:

Usage: shodo download [OPTIONS]

Options:
  --target TEXT      Target directory to save files
  --in-tree BOOLEAN  Download only files with task Folder
  --help             Show this message and exit.