r
/
Runic.jl
mirror of https://github.com/fredrikekre/Runic.jl
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Unify editor integration docs.

pull/147/head
Fredrik Ekre 5 months ago
parent
80ca401a1a
commit
21ce1471fa
No known key found for this signature in database
GPG Key ID: DE82E6D5E364C0A2
1 changed files with 8 additions and 4 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 12
      README.md

12
README.md
Unescape View File

@ -213,7 +213,7 @@ repository for installation and setup instructions.
Runic is not (yet) available directly in conform so the following configuration needs Runic is not (yet) available directly in conform so the following configuration needs
to be passed to the setup function. This assumes Runic is installed in the `@runic` shared to be passed to the setup function. This assumes Runic is installed in the `@runic` shared
project as suggested in the [Installation](#installation) section above. Adjust the project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic elsewhere. `--project` flag if you installed Runic somewhere else.
```lua ```lua
require("conform").setup({ require("conform").setup({
@ -246,7 +246,9 @@ Runic can be used as a formatter in [VS Code](https://code.visualstudio.com/) us
extension [Custom Local Formatters](https://marketplace.visualstudio.com/items?itemName=jkillian.custom-local-formatters&ssr=false#overview). extension [Custom Local Formatters](https://marketplace.visualstudio.com/items?itemName=jkillian.custom-local-formatters&ssr=false#overview).
After installing the extension you can configure Runic as a local formatter by adding the After installing the extension you can configure Runic as a local formatter by adding the
following entry to your `settings.json`: following entry to your `settings.json`. This assumes Runic is installed in the `@runic`
shared project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic somewhere else.
```json ```json
"customLocalFormatters.formatters": [ "customLocalFormatters.formatters": [
@ -275,7 +277,9 @@ Refer to the apheleia repository for installation and setup instruction.
Runic is not (yet) available directly in apheleia so the Runic is not (yet) available directly in apheleia so the
following configuration needs to be added to your `.emacs`. following configuration needs to be added to your `.emacs`.
This assumes that Runic is installed in the `@runic` shared project as suggested in the [Installation](#installation) section above. This assumes Runic is installed in the `@runic` shared project as suggested in the
[Installation](#installation) section above. Adjust the `--project` flag if you installed
Runic somewhere else.
``` ```
(push `(runic . ("julia" "--project=@runic" "--startup-file=no" "-e" "using Runic; exit(Runic.main(ARGS))" "--")) apheleia-formatters) (push `(runic . ("julia" "--project=@runic" "--startup-file=no" "-e" "using Runic; exit(Runic.main(ARGS))" "--")) apheleia-formatters)
@ -288,7 +292,7 @@ Runic can be used as a formatter in [Helix](https://helix-editor.com/). Configur
`:format` command to use Runic for julia code by adding the following to the `:format` command to use Runic for julia code by adding the following to the
`languages.toml` configuration file. This assumes Runic is installed in the `@runic` shared `languages.toml` configuration file. This assumes Runic is installed in the `@runic` shared
project as suggested in the [Installation](#installation) section above. Adjust the project as suggested in the [Installation](#installation) section above. Adjust the
`--project` flag if you installed Runic elsewhere. `--project` flag if you installed Runic somewhere else.
``` ```
[[language]] [[language]]

Write Preview
Loading…
Cancel
Save