Files

T

Nicolas Arnold f0fb9153b7 Fix broken querySelectors on techdocs

This change fixes the broken pattern for selecting DOM elements to scroll to.

Previously it had error messages like so:
```
Uncaught DOMException: Failed to execute 'querySelector' on 'Element': '#fn:someidtag' is not a valid selector.
```

This did not bode well with the techdocs integration with footnotes.

The query has now changed to include something that is expected by the DOM queries.

Signed-off-by: Nicolas Arnold <nic@roadie.io>

2022-03-22 09:05:35 +00:00

dev

deprecate EntityName, introduce CompoundEntityRef

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

src

Fix broken querySelectors on techdocs

2022-03-22 09:05:35 +00: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

2022-03-17 09:02:30 +00:00

config.d.ts

clean up deprecations of techdocs plugin

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

package.json

Version Packages

2022-03-17 09:02:30 +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.