Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugins Documentation Part Deux #337

Closed
wants to merge 1 commit into from
Closed

Plugins Documentation Part Deux #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions documentation/aleo/07_tooling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ If you have installed a Leo syntax [plugin](../leo/06_tooling.md)
then you should already be able to see syntax highlighting for `.aleo` Aleo instructions.
:::

Aleo maintains several syntax highlighting implementations across different platforms.
If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).
Aleo maintains several syntax highlighting implementations across different platforms. If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).

1. [Sublime Text](#sublime-text).
2. [Visual Studio Code](#vscode).
Expand All @@ -32,7 +31,8 @@ Aleo instructions support for Sublime's LSP plugin is provided through a languag
Follow these steps to toggle the `Aleo instructions` syntax highlighter.

1. Open `Sublime Text`.
2. From Preferences > Select Color Scheme... > LSP-leo
2. From Settings > Select Color Scheme... > LSP-leo
3. This will also allow you to see syntax highlighting for Aleo instructions.

## VSCode

Expand All @@ -42,12 +42,13 @@ Download the editor here: https://code.visualstudio.com/download.
### Install

1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
2. The correct extension ID is `aleohq.leo-extension`.
2. The correct extension ID is `aleohq.leo-extension`, and the description should state "the official VSCode extension for Leo".

### Usage

1. Open `VSCode`.
2. Go to Settings > Extensions or use the left side panel Extensions button to enable the Leo plugin.
3. This will also allow you to see syntax highlighting for Aleo instructions.

## IntelliJ

Expand All @@ -57,4 +58,5 @@ Download the editor here: https://www.jetbrains.com/idea/download/.
### Install

1. Download the [Aleo Developer Plugin](https://plugins.jetbrains.com/plugin/19890-aleo-developer) from JetBrains marketplace.
2. Click on Plugins on the left side panel > gear icon > Install Plugin from Disk > Select the downloaded zip file
2. Click on the gear icon in the upper right > Plugins > gear icon up top > Install Plugin from Disk > Select the downloaded zip file
3. This will also allow you to see syntax highlighting for Aleo instructions.
Binary file modified documentation/aleo/images/intellij.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/aleo/images/sublime.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/aleo/images/vscode.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 11 additions & 10 deletions documentation/leo/06_tooling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: Tooling for Leo
sidebar_label: Tooling
---

Aleo maintains syntax highlighting implementations across different platforms.
If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).
Aleo maintains syntax highlighting implementations across different platforms. If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).

1. [Sublime Text](#sublime-text)
2. [Visual Studio Code](#vs-code)
Expand All @@ -15,18 +14,19 @@ If you do not see your favorite editor on this list, please reach out on [GitHub

[//]: # (![](./images/sublime.png) )
Download the editor here: https://www.sublimetext.com/download.
Leo support for Sublime's LSP plugin is provided through a language server.
Aleo instructions support for Sublime's LSP plugin is provided through a language-server.

### Install

1. Install [LSP](https://packagecontrol.io/packages/LSP) and [LSP-Leo](https://packagecontrol.io/packages/LSP-leo) from Package Control.
1. Install [LSP](https://packagecontrol.io/packages/LSP) and [LSP-leo](https://packagecontrol.io/packages/LSP-leo) from Package Control.
2. Restart Sublime.

### Usage

Follow these steps to toggle the `Leo` syntax highlighting, hover, and tokens.

1. Open `Sublime Text`.
2. From Preferences > Select Color Scheme... > LSP-aleo-developer
2. From Settings > Select Color Scheme... > LSP-leo

## VS Code

Expand All @@ -35,13 +35,13 @@ Download the editor here: https://code.visualstudio.com/download.

### Install

Install [Leo for VS Code](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from the VS Code marketplace.
The correct extension ID is `aleohq.leo-extension`.
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
2. The correct extension ID is `aleohq.leo-extension`, and the description should state "the official VSCode extension for Leo".

### Usage

1. Open `VS Code`.
2. From Preferences > Color Theme... > Aleo Theme
1. Open `VSCode`.
2. Go to Settings > Extensions or use the left side panel Extensions button to enable the Leo plugin.

## Intellij

Expand All @@ -50,4 +50,5 @@ Download the editor here: https://www.jetbrains.com/idea/download/.

### Install

Install the [Leo for Intellij](https://plugins.jetbrains.com/plugin/19979-leo) from the JetBrains marketplace.
1. Download the [Aleo Developer Plugin](https://plugins.jetbrains.com/plugin/19890-aleo-developer) from JetBrains marketplace.
2. Click on the gear icon in the upper right > Plugins > gear icon up top > Install Plugin from Disk > Select the downloaded zip file
Loading