Files

T

Oliver Sand 7e5bd18cf7 Adjust to review comments

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>

2021-11-11 09:55:03 +01:00

dev

replace entityId with entityRef

2021-09-30 12:21:10 +02:00

src

Adjust to review comments

2021-11-11 09:55:03 +01:00

.eslintrc.js

…

api-report.md

Add <EntityListDocsGrid> and extend <DocsCardGrid> to display the entity title

2021-10-18 11:23:28 +02:00

CHANGELOG.md

Version Packages

2021-10-28 14:06:43 +00:00

config.d.ts

Use lower-case links within techdocs plugin; allow legacy behavior with config.

2021-08-10 13:38:07 +02:00

package.json

Version Packages

2021-10-28 14:06:43 +00:00

README.md

Minor text edits

2021-09-27 17:19:54 +02:00

README.md

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by following our guide on Getting Started.

Configuration

Refer to our configuration reference for a complete listing of configuration options.

TechDocs Storage API

The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. This can be configured by implementing a new techdocs storage API.