https://github.com/littlegnal/iris-doc

A CLI tool that fill the dita json data as comments to code from https://github.com/AgoraIO/agora_doc_source.
https://github.com/littlegnal/iris-doc

Last synced: 15 days ago
JSON representation

A CLI tool that fill the dita json data as comments to code from https://github.com/AgoraIO/agora_doc_source.

• Host: GitHub
• URL: https://github.com/littlegnal/iris-doc
• Owner: littleGnAl
• License: mit
• Created: 2022-08-06T18:17:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-09T14:06:13.000Z (about 1 year ago)
• Last Synced: 2024-12-06T21:36:28.278Z (17 days ago)
• Language: Python
• Homepage:
• Size: 191 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# iris_doc

A CLI tool that fill the dita json data as comments to code from https://github.com/AgoraIO/agora_doc_source.

## Get Started

### dart

```

python3 -m pip install -r requirements.txt

python3 iris_doc.py \

        --config=fmt_config/fmt_dart.yaml \

        --language=dart \

        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/flutter_ng_json_template_cn.json \

        --export-file-path=/Users/exportfile/path/export_file.dart

```

### ts

First install the eslint

```

npm install eslint

```

```

python3 -m pip install -r requirements.txt

python3 iris_doc.py \

        --config=fmt_config/fmt_ts.yaml \

        --language=ts \

        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/rn_ng_json_template_en.json \

        --export-file-path=/Users/exportfile/path/export_file.ts

```

### c_sharp

First install the clang

```

python3 -m pip install -r requirements.txt

python3 iris_doc.py \

        --config=fmt_config/fmt_c_sharp.yaml \

        --language=c_sharp \

        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/unity_ng_doc_template_en.json \

        --export-file-path=/Users/exportfile/path

```

## License

The project is under the MIT license.