Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jetbrains/projector-markdown-plugin

An IntelliJ plugin which provides a delegating Markdown preview
https://github.com/jetbrains/projector-markdown-plugin

awt swing

Last synced: 3 days ago
JSON representation

An IntelliJ plugin which provides a delegating Markdown preview

Host: GitHub
URL: https://github.com/jetbrains/projector-markdown-plugin
Owner: JetBrains
License: mit
Archived: true
Created: 2020-05-29T11:49:35.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-11-05T12:57:37.000Z (about 4 years ago)
Last Synced: 2024-05-29T19:45:18.896Z (8 months ago)
Topics: awt, swing
Language: Java
Homepage: https://youtrack.jetbrains.com/issues/PRJ
Size: 227 KB
Stars: 7
Watchers: 13
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# projector-markdown-plugin
[![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[![Tests status badge](https://github.com/JetBrains/projector-markdown-plugin/workflows/Tests/badge.svg)](https://github.com/JetBrains/projector-markdown-plugin/actions)

An IntelliJ plugin which provides a delegating Markdown preview.

For more info, please check out [Projector.md](https://github.com/JetBrains/projector-server/blob/master/docs/Projector.md).

## This project is obsolete
Since [PRJ-131](https://youtrack.jetbrains.com/issue/PRJ-131), MD Preview is bundled into projector-server, so we don't need a separate MD plugin anymore. It makes of projector installation even easier.

## Building
```shell script
./gradlew :buildPlugin
```

This will build the plugin here: `build/distributions/projector-markdown-plugin-VERSION.zip`.

## Running
For testing purposes, you can run this plugin with UI via
```shell script
./gradlew :runIde
```

To make this plugin useful, you should set up some callbacks. An example can be found in [projector-server](https://github.com/JetBrains/projector-server).

## Note
Since the bundled Markdown plugin doesn't support extensions now ([IDEA-235683](https://youtrack.jetbrains.com/issue/IDEA-235683)), we currently have to provide not only the preview, but also the full copy of the bundled plugin. So you have to **disable the bundled Markdown plugin** first and then enable this one to make it work.

## License
[MIT](LICENSE.txt).