search

kieler / klighd-vscode

Eclipse Public License 2.0
9 stars 6 forks source link

Docs: Add a local documentation example #16

Closed christoph-fricke closed 3 years ago

christoph-fricke commented 3 years ago

This PR adds an example and usage guide on "Using the CLI for Local Documentation".

Sadly, before a user is able to try the example, the diagram-file paths in the html have to be modified to match the local file structure. I tried to use relative paths hoping that it would work if the CLI is used in the same folder, but it generated an exception on the LS.

christoph-fricke commented 3 years ago

Nice example. I tested this to see how this would for me, and only one of the two embedded diagrams loaded for me. Did you change anything on the server side to work with both diagrams as well?

That is strange. Works fine for me and I use the prebuild jars. Did you update the source paths for both iframe elements? I do not see a reason why it would not work otherwise.

christoph-fricke commented 3 years ago

Note for anyone that stumbles upon this PR:

The example does not work when the language server (LS) is started in development mode and connected to on a port. The single server is not able to handle multiple connections. When a JAR is used, the web server is able to spawn multiple LS for multiple connections, as it is the case in this example.

Therefore, to try the example a LS JAR has to be used.