https://github.com/yanncebron/intellipikchr

Support Pikchr (https://pikchr.org/) in IntelliJ-based IDEs.
https://github.com/yanncebron/intellipikchr

diagram-editor diagrams intellij kroki pic pikchr

Last synced: about 1 year ago
JSON representation

Support Pikchr (https://pikchr.org/) in IntelliJ-based IDEs.

• Host: GitHub
• URL: https://github.com/yanncebron/intellipikchr
• Owner: YannCebron
• License: apache-2.0
• Created: 2021-09-11T12:41:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T09:31:31.000Z (about 2 years ago)
• Last Synced: 2024-04-10T18:49:02.536Z (about 2 years ago)
• Topics: diagram-editor, diagrams, intellij, kroki, pic, pikchr
• Language: Kotlin
• Homepage:
• Size: 2.53 MB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# IntelliPikchr

![Build](https://github.com/YannCebron/IntelliPikchr/workflows/Build/badge.svg)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

[![Version](https://img.shields.io/jetbrains/plugin/v/17624.svg)](https://plugins.jetbrains.com/plugin/17624)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/17624.svg)](https://plugins.jetbrains.com/plugin/17624)

> [!IMPORTANT]

> As of November 2024, this plugin is no longer under active development.

Support [Pikchr](https://pikchr.org/) language in IntelliJ-based IDEs (2021.3 and later).

_Pikchr (pronounced "picture") is a PIC-like markup language for diagrams in technical documentation._

                   

![IntelliPikchr](docs/intellipikchr.png)

## Features

 

- Syntax highlighting, customizable in _Settings \| Editor \| Color Scheme \| Pikchr_

- Bundled Live Templates, customize/add in _Settings \| Editor \| Live Templates_

- Split editor with preview pane for `.pikchr` files, using [kroki.io](https://kroki.io) or self-hosted server for rendering

- Adapt preview colors to IDE dark UI mode

- Tune preview with custom CSS

- See _Settings \| Languages & Frameworks \| IntelliPikchr_ to customize (see Settings icon in editor toolbar)

### Plans/Ideas

- Full language support (semantic highlighting, completion, refactoring, ...)

- Previews for diagrams embedded in Markdown code fences

## Installation

            

- Open [Plugin Homepage](https://plugins.jetbrains.com/plugin/17624-intellipikchr) and click *Install to...* button on upper right

- Using IDE built-in plugin system:

  Settings > Plugins > Marketplace > Search for "IntelliPikchr" >  Install Plugin

- Manually:

  Download the [latest release](https://github.com/YannCebron/IntelliPikchr/releases/latest) and install it manually

  using

  Settings > Plugins > ⚙️ > Install plugin from disk...

                             

## License | Code of Conduct | Credits

Licensed under [Apache 2 License](LICENSE)

[Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)

                                      

Split editor adapted from IntelliJ IDEA [Markdown plugin](https://github.com/JetBrains/intellij-community/tree/master/plugins/markdown)

---

Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template