hackmdio / hackmdio/codimd

feature request: the CodiMD "help" panel should list version of the deployed CodiMD instance and its dependencies

Open
#1,639 1 comment 0 reactions 0 assignees View on GitHub
docs enhancement
Dominant language
JavaScript
Stars
10.1k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

I am trying to report an issue to the administrators of the CodiMD instance that I am using. Something does not work properly on their instance, while it does work on other instances. I suspect that the difference can be explained by a different in CodiMD versions or one of its dependencies, but it is surprisingly difficult for a user to tell, from a running instance, which versions are being used.

Suggested fix: the "help" menu should list the version of CodiMD that is running, as well as its main dependencies (javascript frameworks, MathJax, etc.). (In my case the problem is related to syntactic highlighting of code blocks, and I suspect that the CodiMD versions themselves are the same, but it may be the highlight.js versions that differ).

(Listing the dependencies, their authors, versions and licenses may also be necessary to comply to the open-source license terms of some of your dependencies. It is generally a good practice for end-user applications.)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.