Commit Graph

22 Commits

Author SHA1 Message Date
Konstantin Schaper
7286a62a80 Implement api for extension point typings (#1638)
Currently, the only way to explore available extension points is through our documentation or by browsing the source code. Once you find them, there is no guard rails and the usage is prone to user errors. This new api allows the declaration of extension points as types in code. This way, exposing an extension point is as easy as exporting it from a module. Both the implementation and the developer who uses the extension point work with the same shared type that allows auto-completion and type-checks for safety. This feature is backwards-compatible as the generic methods all have sensible defaults for the type parameters.

Co-authored-by: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
2021-05-12 16:05:30 +02:00
Eduard Heimbuch
708f262454 Add testing guide (#1653) 2021-05-12 13:28:04 +02:00
Konstantin Schaper
32b268e6f5 add extension point for custom link protocol renderers in markdown (#1639)
This PR allows for custom link protocols to be declared and rendered in markdown.
A new extension point markdown-renderer.link.protocol allows for renderers to hook into the api and implement any custom protocol.

Example:

[description](myprotocol:somelink)
binder.bind("markdown-renderer.link.protocol", { protocol: "myprotocol", renderer: MyProtocolRenderer })
This renderer functions similar to link renderers and receives the href and the description. The latter as the children property.

This PR also fixes two bugs where external- and anchor links were not correctly rendered in pull requests by the review-plugin.

Co-authored-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
2021-04-29 13:15:22 +02:00
Eduard Heimbuch
84c1e7ed37 Add new extension point for repository avatars (#1614)
Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
2021-04-15 11:14:42 +02:00
Eduard Heimbuch
44577e9bc4 Add architecture overview documentation (#1516)
* Add architecture overview documentation

* Use plant uml the Cloudogu way

Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>
2021-02-03 11:24:02 +01:00
Konstantin Schaper
831c8b0271 add markdown codeblock renderer extension point (#1492)
Introduces a new extension point that allows developers to overwrite the default syntax highlighting renderer for specific code blocks defined in markdown. The extension point is dynamic and follows the pattern "markdown-renderer.code.{language}".
This feature lays the groundwork for the scm-markdown-plantuml-plugin.
2021-01-07 09:25:31 +01:00
Sebastian Sdorra
2ea019231a Document configuration for null checks 2020-10-15 11:58:20 +02:00
René Pfeuffer
1ffe68484f Add documentation for integration tests 2020-08-07 20:54:23 +02:00
Sebastian Sdorra
c352f9a751 added deprecation mark 2020-07-02 10:54:06 +02:00
Sebastian Sdorra
08aa6fafff fixed typo 2020-07-02 10:53:48 +02:00
René Pfeuffer
0387b7aa5e Describe changed extension point 2020-07-02 08:14:26 +02:00
René Pfeuffer
39743f2db8 Remove flow config from IDE setup documentation 2020-06-23 08:18:09 +02:00
René Pfeuffer
83a6396751 Remove old link 2020-06-11 11:27:39 +02:00
René Pfeuffer
f1ce32afd6 Fix typo 2020-06-11 11:27:39 +02:00
Sebastian Sdorra
58b60636ac fixed more broken links in documentation 2020-06-11 11:27:39 +02:00
Sebastian Sdorra
d03af49df9 update documentation
* fix broken links
* remove v1 related stuff
* restructure
2020-06-11 11:27:39 +02:00
Konstantin Schaper
0d37378dc6 Add livereload flag to intellij config docs 2020-05-14 10:55:50 +02:00
Eduard Heimbuch
d6b1292102 rename common-pitfalls file 2020-05-07 13:16:08 +02:00
Eduard Heimbuch
1625cb386c move common pitfall guide to existing common-pitfall.md 2020-05-07 13:09:46 +02:00
René Pfeuffer
b1485896e0 Move plugin development to top level navigation 2020-05-07 08:47:11 +02:00
René Pfeuffer
9226654c5d Structure navigation 2020-05-06 21:36:20 +02:00
Konstantin Schaper
8b2d9d1d95 Establish preliminary structure for documentation 2020-05-06 19:56:34 +02:00