Skip to content

Commit

Permalink
Merge branch 'main' of github.com:Feel-ix-343/obsidian-markdown-ls
Browse files Browse the repository at this point in the history
  • Loading branch information
Feel-ix-343 committed Feb 28, 2024
2 parents bed3060 + 95b0815 commit 2893fbd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ If you are using Arch Linux, you can install the latest Git version through the
paru -S markdown-oxide-git
```

### Manual
### Manual (for MacOS, Windows, and *other* linux distributions)

Clone the repository and then run `cargo build --release`.

You will subsequently need the path to the release binary when you configure your editor. It can be found relative to the root of the project at `target/release/markdown-oxide`

## Usage

To use the language server, you need to follow the instructions for your editor of choice below.
Expand Down Expand Up @@ -90,7 +92,7 @@ vim.api.nvim_exec_autocmds('User', { pattern = 'LspAttached' })

The linking syntax is that of Obsidian's and can be found here https://help.obsidian.md/Linking+notes+and+files/Internal+links

Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[articles/markdown oxide#Features|Markdown Oxide Features]] to link to a heading in `Markdown Oxide.md` file in the `articles` folder or [[Obsidian]] for the `Obsidian.md` file in the root folder.
Generally, this is `[[relativeFilePath(#heading)?(|display text)?]]` e.g. [[articles/markdown oxide#Features|Markdown Oxide Features]] to link to a heading in `Markdown Oxide.md` file in the `articles` folder or [[Obsidian]] for the `Obsidian.md` file in the root folder.

## Features

Expand Down

0 comments on commit 2893fbd

Please sign in to comment.