Cleanup README.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
6ed4767b18
commit
d9c86edd4e
69
README.md
69
README.md
|
@ -9,65 +9,18 @@ this notice are preserved. This file is offered as-is, without any warranty.
|
||||||
# vscode-texinfo
|
# vscode-texinfo
|
||||||
|
|
||||||
[![Build Status](https://shields.io/drone/build/CismonX/vscode-texinfo?server=https%3A%2F%2Fdrone.cismon.net)](https://drone.cismon.net/CismonX/vscode-texinfo)
|
[![Build Status](https://shields.io/drone/build/CismonX/vscode-texinfo?server=https%3A%2F%2Fdrone.cismon.net)](https://drone.cismon.net/CismonX/vscode-texinfo)
|
||||||
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
|
[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE)
|
||||||
|
|
||||||
Texinfo language support for Visual Studio Code.
|
## About
|
||||||
|
|
||||||
## Features
|
This project is an extension of Visual Studio Code which aims at improving user
|
||||||
|
experience for editing Texinfo documents.
|
||||||
|
|
||||||
* **Syntax Highlighting**
|
Major features include:
|
||||||
* 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).
|
* Syntax Highlighting
|
||||||
* **Code Completion**
|
* Code Completion
|
||||||
* Completion and code snippets for most @\-commands.
|
* HTML Preview
|
||||||
* **Preview**
|
* Folding & Breadcrumb Navigation
|
||||||
* Display HTML preview in a webview.
|
* Diagnostics
|
||||||
* Support loading custom CSS for preview.
|
|
||||||
* Texinfo to HTML conversion is provided by [GNU Texinfo](https://www.gnu.org/software/texinfo).
|
|
||||||
* **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.
|
|
||||||
|
|
||||||
<details>
|
## Documentation
|
||||||
<summary>Screenshots:</summary>
|
|
||||||
|
|
||||||
Display preview:
|
|
||||||
![preview](https://user-images.githubusercontent.com/19173506/98842831-15355880-2485-11eb-9a12-a709d930ac05.png)
|
|
||||||
|
|
||||||
Code completion:
|
|
||||||
![completion](https://user-images.githubusercontent.com/19173506/98842873-254d3800-2485-11eb-8cef-78a534b08b84.png)
|
|
||||||
|
|
||||||
Breadcrumb navigation:
|
|
||||||
![navigation](https://user-images.githubusercontent.com/19173506/98842850-1ebec080-2485-11eb-8da7-2d167ea86ccf.png)
|
|
||||||
|
|
||||||
Folding:
|
|
||||||
![folding](https://user-images.githubusercontent.com/19173506/98842863-21b9b100-2485-11eb-85f9-d6c9d317d307.png)
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
![diagnostics](https://user-images.githubusercontent.com/19173506/98842883-28482880-2485-11eb-9399-6046e8873014.png)
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
* Visual Studio Code version >= 1.40.0. Legacy versions may also work.
|
|
||||||
* A latest version of GNU Texinfo.
|
|
||||||
|
|
||||||
## Extension Settings
|
|
||||||
|
|
||||||
See `File -> Preferences -> Settings -> Extensions -> Texinfo` for details. The settings are self-explanatory.
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
* If syntax highlighting is not satisfactory, try another color theme (e.g. Solarized Light/Dark, Monokai) where keyword/operator colors are distinct.
|
|
||||||
* 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.
|
|
||||||
* 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.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Send an email to [bug-report@cismon.net](mailto:bug-report@cismon.net) to report bugs or submit patches.
|
|
||||||
|
|
||||||
## Future Plans
|
|
||||||
|
|
||||||
* 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.
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "texinfo",
|
"name": "texinfo",
|
||||||
"displayName": "Texinfo Language Support",
|
"displayName": "Texinfo Language Support",
|
||||||
"description": "Provides basic editing experience for Texinfo documents, including syntax highlighting, code completion, HTML preview, etc.",
|
"description": "Texinfo language support for Visual Studio Code",
|
||||||
"publisher": "cismonx",
|
"publisher": "cismonx",
|
||||||
"version": "0.1.4",
|
"version": "0.1.4",
|
||||||
"author": {
|
"author": {
|
||||||
|
|
Loading…
Reference in New Issue