Files

T

Eric Peterson 78e31e6b68 Merge pull request #9244 from jonathan-ash/techdocs-reader-custom-error-page

Added the option to supply a custom error page to TechDocsPage

2022-02-21 17:50:03 +01:00

dev

replace entityId with entityRef

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

src

Merge pull request #9244 from jonathan-ash/techdocs-reader-custom-error-page

2022-02-21 17:50:03 +01:00

.eslintrc.js

…

api-report.md

Merge pull request #9569 from backstage/bump-mkdocs-material

2022-02-21 11:38:07 +01:00

CHANGELOG.md

Version Packages

2022-02-17 10:38:59 +00:00

config.d.ts

techdocs(sanitizer): adds iframe support (#8237 )

2021-12-27 12:01:22 +01:00

package.json

Version Packages

2022-02-17 10:38:59 +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.