Files

T

Crevil 8acb22205c Add navigation scroll to techdocs

Currently the active navigation item might be hidden behind nested items or out
of view on load.

This change adds a techdocs transformer that scrolls any active item into view
and expands any nested active items.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>

2022-07-28 08:01:29 +02:00

dev

Review feedback 2: electric boogaloo

2022-04-12 15:37:29 +02:00

src

Add navigation scroll to techdocs

2022-07-28 08:01:29 +02:00

.eslintrc.js

packages,plugins: migrate to new lint config

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

api-report.md

Merge remote-tracking branch 'origin/master' into reconfigure

2022-07-19 18:15:50 +02:00

CHANGELOG.md

Version Packages (next)

2022-07-26 08:37:39 +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-07-26 08:37:39 +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.