Structure documentation in /docs

2020-03-13 18:51:54 +01:00
parent 336295b671
commit 85f5ca9441
14 changed files with 235 additions and 45 deletions
@@ -0,0 +1,21 @@
+# createPlugin - router
+
+The router that is passed to the `register` function includes makes it possible for plugins to hook into routing of the Backstage app and provide the end users with new views to navigate to.
+
+```typescript
+type RouterHooks = {
+  registerRoute(
+    path: RoutePath,
+    Component: ComponentType<any>,
+    options?: RouteOptions,
+  ): void;
+
+  registerRedirect(
+    path: RoutePath,
+    target: RoutePath,
+    options?: RouteOptions,
+  ): void;
+};
+```
+
+[Back to References](README.md)