Skip to content

Commit

Permalink
Set :idprefix: and :idseparator: in adoc files
Browse files Browse the repository at this point in the history
Currently, the "getting started" links in the project README successfully link
to the `#getting-started` section on GitHub, but fail to link on
developers.yubico.com because the heading ID there is `#_getting_started`
instead. These settings should resolve this.
  • Loading branch information
emlun committed Jul 22, 2024
1 parent 28cd549 commit 12424fe
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ java-webauthn-server
:toc:
:toc-placement: macro
:toc-title:
:idprefix:
:idseparator: -

image:https://github.com/Yubico/java-webauthn-server/workflows/build/badge.svg["Build Status", link="https://github.com/Yubico/java-webauthn-server/actions"]
image:https://img.shields.io/endpoint?url=https%3A%2F%2FYubico.github.io%2Fjava-webauthn-server%2Fcoverage-badge.json["Mutation test coverage", link="https://Yubico.github.io/java-webauthn-server/"]
Expand Down
2 changes: 2 additions & 0 deletions doc/Migrating_from_v1.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= v1.x to v2.0 migration guide
:idprefix:
:idseparator: -

The `2.0` release of the `webauthn-server-core` module
removes some deprecated features
Expand Down
2 changes: 2 additions & 0 deletions webauthn-server-attestation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
:toc:
:toc-placement: macro
:toc-title:
:idprefix:
:idseparator: -

An optional module which extends link:../[`webauthn-server-core`]
with a trust root source for verifying
Expand Down
2 changes: 2 additions & 0 deletions webauthn-server-attestation/doc/Migrating_from_v1.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= v1.x to v2.1 migration guide
:idprefix:
:idseparator: -

The `2.0` release of the `webauthn-server-attestation` module
makes lots of breaking changes compared to the `1.x` versions.
Expand Down
2 changes: 2 additions & 0 deletions webauthn-server-core/README
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= Web Authentication server library
:idprefix:
:idseparator: -

Implementation of a Web Authentication Relying Party (RP).

Expand Down
2 changes: 2 additions & 0 deletions webauthn-server-demo/README
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= webauthn-server-demo
:idprefix:
:idseparator: -

A simple self-contained demo server supporting multiple authenticators per user.
It illustrates how to use the required integration points, the most important of
Expand Down

0 comments on commit 12424fe

Please sign in to comment.