Files

T

Camila Belo bf4d052897 fix(techdocs): code block margins

Signed-off-by: Camila Belo <camilaibs@gmail.com>

2022-03-28 10:52:32 +02:00

dev

deprecate EntityName, introduce CompoundEntityRef

2022-03-02 21:54:45 +01:00

src

fix(techdocs): code block margins

2022-03-28 10:52:32 +02:00

.eslintrc.js

packages,plugins: migrate to new lint config

2022-03-07 14:53:43 +01:00

api-report.md

api report fixup

2022-03-14 22:39:19 +01:00

CHANGELOG.md

Version Packages (next)

2022-03-22 12:28:03 +00:00

config.d.ts

clean up deprecations of techdocs plugin

2022-03-14 22:39:17 +01:00

package.json

Version Packages (next)

2022-03-22 12:28:03 +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.