https://github.com/artempyanykh/marksman-vscode

Marksman extension for VSCode. Note taking with cross-references and diagnostics.
https://github.com/artempyanykh/marksman-vscode

autocompletion language-server lsp markdown note vscode vscode-extension

Last synced: 6 days ago
JSON representation

Marksman extension for VSCode. Note taking with cross-references and diagnostics.

• Host: GitHub
• URL: https://github.com/artempyanykh/marksman-vscode
• Owner: artempyanykh
• License: mit
• Created: 2021-03-06T13:25:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T19:06:31.000Z (11 months ago)
• Last Synced: 2024-11-01T04:34:39.401Z (13 days ago)
• Topics: autocompletion, language-server, lsp, markdown, note, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://github.com/artempyanykh/marksman
• Size: 2.14 MB
• Stars: 39
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Marksman VSCode

Integrates [Marksman][mn] language server into VSCode for delightful Markdown

note taking experience.

See the [project page][mn] for more detailed information.

## Screenshots

- Hover preview:

  ![Hover](./assets/readme/vsc-wiki-hover.png)

- Completion:

  

  - Wiki link to another document:

    ![Completion for wiki](./assets/readme/vsc-wiki-compl.png)

  - Wiki link to a subsection of the current document:

    ![Completion for wiki heading](./assets/readme/vsc-wiki-heading-compl.png)

  - Reference link:

    ![Completion for ref link](./assets/readme/vsc-ref-compl.png)

- "Show References":

  ![Show references](./assets/readme/vsc-find-references.png)

- Project-wide diagnostics for broken wiki-links:

  ![Diagnostics](./assets/readme/vsc-diag.png)

## Installation

1. **Get `marksman` server binary**.

   The extension will try to automatically download Marksman language server

   from GH releases. This is the easiest way to get started.

   An alternative is to either download `marksman` binary from the [releases

   page][mn-releases] or to build `marksman` from source. Put it somewhere in

   your `PATH` and you should be good to go.

2. **Add `.marksman.toml` to your workspace root folder**.

   The extension is automatically activated only when `.marksman.toml` file is

   present. This is done to avoid running Zeta Note on random Markdown files,

   but rather only inside your notes folder.

## Extension Settings

- **Custom Command**: allows to specify a custom command to start

  `marksman`. Mostly useful for development of `marksman` itself.

- **Custom Command Dir**: allows to specify a CWD for the command above. For

  development it's convenient to set the command to `dotnet run` and the command

  dir to the dir where `marksman` sources are.

## Development

- **Set things up**: 

  - Run `npm install` to get the necessary packages.

  - Run `npm watch` or hit F5 to do development/debugging.

- **Package and release**:

  - Install vsce via `npm install -g vsce`.

  - Run `vsce package` to package the extension.

  - Run `vsce publish` to publish the packaged archive.

- **Local installation**:

  - Run `code --install-extension [path-to-vsix]` to install the locally built extension.

[roam]: https://roamresearch.com

[md-memo]: https://github.com/svsool/vscode-memo

[mn]: https://github.com/artempyanykh/marksman

[mn-releases]: https://github.com/artempyanykh/marksman/releases