markmark

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 21 Open GitHub ↗

Markdown language tooling, exposed as a language server

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# markmark

[![CI](https://github.com/nikku/markmark/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/markmark/actions/workflows/CI.yml)

[Markdown](https://en.wikipedia.org/wiki/Markdown) language tooling. Use standalone or plug-in as a [language server](https://microsoft.github.io/language-server-protocol/) into your favorite IDE.

## Features

Language tooling and code intelligence for [Markdown](https://en.wikipedia.org/wiki/Markdown) files:

* [x] Go to definition
* [x] Find references
* [x] Complete links and tags
* [X] Validate links

Scalable across many Markdown files:

* [x] Project awareness
* [x] Built in or external file watching support

Exposed as a [language server](#language-server), but also usable [standalone](#standalone).

## Installation

```sh
npm install -g markmark
```

## Usage

### Language Server

Start using `markmark-lsp` binary (depends on the [language server protocol](https://microsoft.github.io/language-server-protocol/) integration of your editor):

```
markmark-lsp --stdio
```

### Standalone

Instantiate `markmark` yourself to integrate it into your applications:

```javascript
import { Markmark } from 'markmark';

const markmark = new Markmark(console);

// intialize
markmark.init({ watch: true });

// add a search root
markmark.addRoot('file:///some-folder');

// listen on <ready>
markmark.on('ready', () => {
  console.log('Markmark is ready!');
});

// find references at position
const refs = markmark.findReferences({
  uri: 'file:///some-folder/foo.md',
  position: {
    start: { line: 1, column: 5 },
    end: { line: 1, column: 5 }
  }
});

// find definitions at document position
const defs = markmark.findDefinitions({
  uri: 'file:///some-folder/foo.md',
  position: {
    start: { line: 1, column: 5 },
    end: { line: 1, column: 5 }
  }
});
```

## License

MIT

markmark

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

markmark

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README