Feedback to new integration for JetBrains IDEs

[jansorg]

I'm author of BashSupport Pro, a shell script plugin for JetBrains IDEs.
I'm currently preparing support for tldr pages for the next major version.

I'm posting here to confirm that I'm fulfilling all requirements and that there's no obvious problem with the integration.

It's not a normal client integration, because it's integrated in the documentation for shell script commands.

The integration is showing attribution with each rendered documentation.

If you think that there's anything wrong with the rendering or that the attribution needs to be changed, please let me know.

Here's how it's rendering:

[kbdharun]

Hi, It's a pretty nice integration you got there.

I'm posting here to confirm that I'm fulfilling all requirements and that there's no obvious problem with the integration.

It's not a normal client integration, because it's integrated in the documentation for shell script commands.

The integration is showing attribution with each rendered documentation.

If you think that there's anything wrong with the rendering or that the attribution needs to be changed, please let me know.

The basic page rendering (with placeholder highlighting) LGTM and the attribution is great too.

I have a few additional suggestions/feedback to ensure the client would be fully functional:

• If possible, can you show a page with placeholder highlighting (for reference see our client specification page structure section) i.e., docker-inspect. The placeholder escaped page with curly braces rendered inside the placeholder would be like this:

---

• In tldr, we have a concept of alias pages where we reference another complete page from a basic placeholder page i.e., we reference vim in vi with tldr vim command here:

We follow something similar to reference subcommands in a tool's main page or in case of name collisions with disambiguation pages i.e. tldr mc.

Would it be possible to do custom routing so that when the user clicks on an alias page (let's say named sc) example with tldr somecommand the referenced somecommand page is displayed to them.

[jansorg]

Thank you for your kind feedback!

• If possible, can you show a page with placeholder highlighting (for reference see our [client specification page structure section]

Here's the rendering:

• In tldr, we have a concept of alias pages where we reference another complete page from a basic placeholder page i.e., we reference vim in vi with tldr vim command here:
  We follow something similar to reference subcommands in a tool's main page or in case of name collisions with disambiguation pages i.e. tldr mc.

Would it be possible to do custom routing so that when the user clicks on an alias page (let's say named sc) example with tldr somecommand the referenced somecommand page is displayed to them.

This should hopefully be possible, but I'll have to investigate and implement this after the initial release with tldr support.

I forgot to mention that BashSupport Pro bundles a snapshot of tldr pages with its distribution. It's also bundling a copy of this license file with the same distribution ZIP:

<!-- markdownlint-disable MD041 -->
Copyright © 2014—present the [tldr-pages team](https://github.com/orgs/tldr-pages/people)
and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors).

**This work is licensed under the
[Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/)
(CC-BY).**

----

The contents of the [scripts/](https://github.com/tldr-pages/tldr/tree/main/scripts) directory
are licensed under the MIT license:

> **The MIT License**
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in
> all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> THE SOFTWARE.