2020-10-03 18:04:18 +00:00
# vscode-texinfo
2021-02-09 09:12:29 +00:00
[](https://drone.cismon.net/CismonX/vscode-texinfo)
2020-10-04 12:40:54 +00:00
[](LICENSE)
2020-10-03 18:28:19 +00:00
2020-10-03 18:04:18 +00:00
Texinfo language support for Visual Studio Code.
## Features
2020-10-15 18:43:07 +00:00
* **Syntax Highlighting**
* Provided by the same [TextMate grammar ](https://github.com/Alhadis/language-texinfo/blob/v1.0.0/grammars/texinfo.cson ) as [used in GitHub ](https://github.com/github/linguist/pull/4589 ).
* **Code Completion**
2020-11-13 07:22:08 +00:00
* Completion and code snippets for most @\-commands.
2020-10-15 18:43:07 +00:00
* **Preview**
* Display HTML preview in a webview.
2021-02-23 10:47:51 +00:00
* Support loading custom CSS for preview.
2020-10-22 22:40:41 +00:00
* Texinfo to HTML conversion is provided by [GNU Texinfo ](https://www.gnu.org/software/texinfo ).
2020-11-13 07:22:08 +00:00
* **Folding**
* Fold on nodes, block commands and multiline comments.
* Breadcrumb navigation of folding blocks.
* **Diagnostics**
* Show diagnostic information in editor based on error and warning messages generated by GNU Texinfo.
2020-10-11 19:27:53 +00:00
< details >
2020-10-15 18:43:07 +00:00
< summary > Screenshots:< / summary >
2020-10-11 19:27:53 +00:00
2020-11-11 17:28:33 +00:00
Display preview:
Code completion:
Breadcrumb navigation:
Folding:
2020-11-13 07:22:08 +00:00
Diagnostics:
2020-11-11 17:28:33 +00:00
2020-10-11 19:27:53 +00:00
< / details >
2020-10-03 18:04:18 +00:00
## Requirements
2020-10-15 18:43:07 +00:00
* Visual Studio Code version >= 1.40.0. Legacy versions may also work.
* A latest version of GNU Texinfo.
2020-10-03 18:04:18 +00:00
## Extension Settings
2020-10-11 19:27:53 +00:00
See `File -> Preferences -> Settings -> Extensions -> Texinfo` for details. The settings are self-explanatory.
## Notes
2020-10-15 18:43:07 +00:00
2020-10-24 15:50:20 +00:00
* If syntax highlighting is not satisfactory, try another color theme (e.g. Solarized Light/Dark, Monokai) where keyword/operator colors are distinct.
2020-11-13 07:22:08 +00:00
* Preview content is updated on document save rather than document change, as Texinfo documents tend to be rather large, and incremental conversion is not yet supported.
2020-10-15 20:16:13 +00:00
* For macOS users: Preinstalled GNU Texinfo distribution is very old. Use a latest one instead. This can be easily done by `brew install texinfo` and change extension setting `texinfo.makeinfo` value.
2020-10-15 18:43:07 +00:00
2021-02-23 10:47:51 +00:00
## Contributing
Send an email to [bug-report@cismon.net ](mailto:bug-report@cismon.net ) to report bugs or submit patches.
2020-10-15 18:43:07 +00:00
## Future Plans
2020-10-22 22:40:41 +00:00
* Implement [Language Server Protocol ](https://microsoft.github.io/language-server-protocol ) for the Texinfo language, preferably by extending GNU Texinfo, to alleviate the limitations of the current implementaion.
