Skip to content

ArtsiomCh/KDocCleanRead

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KDoc Clean Read plugin for IntelliJ platform IDEs.

Making KDoc (Kotlin) comments more readable by:

  • Text styles for value of tags:
    • `code` and "    code"
    • _regular emphasis_ *regular emphasis*
    • __strong emphasis__ **strong emphasis**
    • [link name](http://...)
  • Hiding(folding) brackets at some markdown tags:
    • `code` -> code ;
    • _emphasis_ -> emphasis ;
    • **emphasis** -> emphasis ;
    • [link] -> link ;
    • [my github](http://github.com/ArtsiomCh) -> my github(github.com)
  • Tag and tag's value text styles are customisable at:
    Settings -> Editor -> Color Scheme -> KDoc Clean Read.

Plugin is based on JavaDoc Clean Read.

Tags hiding is implemented through IntelliJ code folding. So all shortcuts (Ctrl+. Ctrl+NumPad + and others) works. As well as code folding toggles (like ) shown in the editor to the left of the corresponding multiline folding regions.

There are some limitations for corner cases in current release: multiline tags, nested tags, simplified parsing of escaped emphasis, misbehaves of IDEA built-in KDoc parser Misbehaves of KDoc..., etc. But mostly it works fine.

License

Plugin is open-source software and is licenced under GPL v3 licence.

Versions

0.0.1 - Initial MVP release:

  • Text styles for value of markdown tags: ` ; _ and * ; __ and ** ; [link name](http...)
  • Hiding(folding) brackets at some markdown tags: ` ; _ and * ; __ and ** ; [link] ; [link name](http...)
  • Customisation at: Settings -> Editor -> Color Scheme -> KDoc Clean Read.
  • About

    Plugin for IntelliJ platform IDEs. Making KDoc comments more readable

    Resources

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published