Skip to content

Commit

Permalink
Update extension description
Browse files Browse the repository at this point in the history
  • Loading branch information
domi-b committed Oct 15, 2024
1 parent 88da8d6 commit 5ba40b5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# ILI File Highlighter
# INTERLIS 2.4 language support

[![CI](https://github.com/GeoWerkstatt/vsc_interlis2_extension/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/GeoWerkstatt/vsc_interlis2_extension/actions/workflows/ci.yml)
[![Release](https://github.com/GeoWerkstatt/vsc_interlis2_extension/actions/workflows/release.yml/badge.svg)](https://github.com/GeoWerkstatt/vsc_interlis2_extension/actions/workflows/release.yml)
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/geowerkstatt.InterlisLanguageSupport)](https://marketplace.visualstudio.com/items?itemName=geowerkstatt.InterlisLanguageSupport)
[![License](https://img.shields.io/github/license/GeoWerkstatt/vsc_interlis2_extension)](https://github.com/GeoWerkstatt/vsc_interlis2_extension/blob/master/LICENSE.txt)


![image](https://user-images.githubusercontent.com/3465512/194811328-616104ab-5855-44e6-a5ec-0997d6403f59.png)


## Description
A Visual Studio Code extension for adding color highlighting to INTERLIS 2.4 files. The colors are customizable but by default the current color theme's colors are used. In addition, this extension provides snippets for commonly used blocks in INTERLIS 2.

**Note**
A Visual Studio Code extension providing INTERLIS 2.4 language support. The colors of the syntax highlighting are customizable using the colors of the current color theme by default. In addition, this extension provides snippets for commonly used blocks in INTERLIS 2 and a markdown documentation generator.

## Features
### Syntax Highlighting
Expand Down Expand Up @@ -41,4 +44,7 @@ To make VS Code treat other file extensions than the default `.ili` as INTERLIS2
"*.ili*": "INTERLIS2"
},
```
The example above associates extensions such as `.ili` with the INTERLIS2 File highlighter extension.
The example above associates extensions such as `.ili` with this extension.

### Markdown documentation
The extension provides the command "Generate markdown documentation" to create markdown code from an INTERLIS 2 file describing the classes and their attributes. This command can be executed from the Command Palette (Default hotkey `Ctrl+Shift+P`) or the context menu of an open INTERLIS 2 file.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "InterlisLanguageSupport",
"displayName": "INTERLIS 2",
"description": "Syntax highlighting for INTERLIS 2.4",
"description": "Language support for INTERLIS 2.4",
"icon": "images/iliIcon.PNG",
"publisher": "geowerkstatt",
"license": "MIT",
Expand Down

0 comments on commit 5ba40b5

Please sign in to comment.