https://github.com/atsushieno/vscode-language-review

Re:VIEW language Support for Visual Studio Code. / issue/PRは日本語でも対応できます
https://github.com/atsushieno/vscode-language-review

language review vscode

Last synced: 4 months ago
JSON representation

Re:VIEW language Support for Visual Studio Code. / issue/PRは日本語でも対応できます

• Host: GitHub
• URL: https://github.com/atsushieno/vscode-language-review
• Owner: atsushieno
• License: other
• Created: 2016-10-29T15:47:59.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T11:01:38.000Z (about 1 year ago)
• Last Synced: 2025-04-01T15:56:22.267Z (7 months ago)
• Topics: language, review, vscode
• Language: TypeScript
• Homepage:
• Size: 1.51 MB
• Stars: 43
• Watchers: 3
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Important Updates on v0.6.0

Version 0.6.0 drops the bundled support for [prh](https://github.com/prh) because there is now a standalone package for it. If you miss the validation feature, please install "prh" extension.

# What is vscode-language-review?

vscode-language-review is a [Visual Studio Code](https://github.com/Microsoft/vscode/) extension for [Re:VIEW](https://github.com/kmuto/review) markup language.

The extension features:

- Live preview on edits.

![Live preview on edits](docs/images/sshot-preview.png)

- Diagnostic reports on save and preview. If you would also like proof-reading helper, use [vscode-prh-extension](https://github.com/prh/vscode-prh-extention).

![Diagnostic reports on save and preview](docs/images/sshot-diagnostic.png)

- List document sections and jump to them.

![List document sections and jump to them](docs/images/sshot-structure.png)

# How to Build and Run when debugging this extension

- Check out this repository.

- Run `npm install` for the first build.

- Launch VSCode, use "Open Folder" command to open this directory (that contains this README.md).

- Type `F5` key.

# Known Issues

Check out [github issues](https://github.com/atsushieno/vscode-language-review/issues).

# License

The primary license is MIT (see [LICENSE.md](LICENSE.md)). Note that this repository and the extension binary package also contain third-party sources, namely:

- syntaxes/review.tmLanguage is taken from [yanzm/ReVIEW](https://github.com/yanzm/ReVIEW), Apache License Version 2.0

- review.js-vscode, packaged in the binary distribution of this extension, is taken from [yfakariya/review.js-vscode](https://github.com/yfakariya/review.js-vscode) which is a fork of [vvakame/review.js](https://github.com/vvakame/review.js), MIT License.

- and all the subsequent dependencies are packaged in the extension too.

# Other projects

- https://github.com/erukiti/ya-language-review also provides Re:VIEW preview and diagnostic features. It runs `review` locally (while my extension is based on review.js) so you can get the very latest features, in case you need them.