Skip to content

Commit

Permalink
chore: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tihonove committed Jan 12, 2025
1 parent 2520d40 commit 42637a3
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# RelaxNG outline

![RelaxNG Outline Screenshot](docs/BaseScreenshot.png)

This Visual Studio Code extension provides an outline view for RelaxNG documents. Please note that RelaxNG support is partial, and this is an alpha version of the plugin.

## Features
- Displays an outline for RelaxNG files
- Allows navigation to specific nodes in the RelaxNG document
- Provides commands copy node paths

## Installation
1. Open the Extensions view in Visual Studio Code.
2. Search for "RelaxNG outline".
3. Click "Install".

## Usage
1. Open a RelaxNG file in Visual Studio Code.
2. The outline view will automatically display the structure of the RelaxNG document.

## Known Issues
- Partial support for RelaxNG syntax.
- This is an alpha version, so expect some bugs and incomplete features.

## Contributing
Contributions are welcome! Please submit issues and pull requests on the [GitHub repository](https://github.com/tihonove/vscode-relaxng-outline).

## License
This extension is licensed under the MIT License.
Binary file added docs/BaseScreenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 2 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"displayName": "RelaxNG outline",
"description": "Display outline for RelaxNG files",
"publisher": "tihonove",
"version": "0.0.1",
"version": "0.1.0",
"license": "MIT",
"engines": {
"vscode": "^1.74.0"
Expand All @@ -12,10 +12,7 @@
"type": "git",
"url": "https://github.com/tihonove/vscode-relaxng-outline.git"
},
"extensionKind": [
"ui",
"workspace"
],
"extensionKind": ["ui"],
"categories": [
"Visualization"
],
Expand Down

0 comments on commit 42637a3

Please sign in to comment.