Skip to content

Conversation

@RayOffiah
Copy link
Contributor

Adding support for footnotes that can appear anywhere on the page.

@RayOffiah RayOffiah self-assigned this Jun 29, 2025
@RayOffiah RayOffiah marked this pull request as ready for review July 2, 2025 13:01
@RayOffiah RayOffiah requested a review from osfameron July 2, 2025 13:01
Copy link
Collaborator

@osfameron osfameron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to replace the UI bundle when that's merged in

@osfameron
Copy link
Collaborator

I think the steps to get this merged in are:

  1. PR in e.g. docs-server that makes use of it, along with a preview.
    Get the PR approved by one other person working on docs-server.

  2. docs-ui PR merged

  3. update this PR with new UI version number and then merge.

I think 1) is important because we don't want the complexity of extensions added just "on the off chance", but because they have a recognized benefit to the team.

@RayOffiah RayOffiah marked this pull request as draft July 2, 2025 14:40
@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch 4 times, most recently from 5b44440 to 6fb9dc8 Compare July 7, 2025 08:14
@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch from b171378 to 020bf30 Compare July 11, 2025 13:09
@RayOffiah RayOffiah marked this pull request as ready for review July 18, 2025 10:52
@RayOffiah RayOffiah requested a review from osfameron July 18, 2025 10:52
@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch from 9ee9632 to 28af089 Compare July 18, 2025 11:28

|1
|Product Aafnote:first-block[This is the first footnote]
|High-quality widget with advanced features{empty}afnote:first-block[This is the second]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the {empty} to disambiguate, we should have that throughout to recommend that as best practice.

@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch 2 times, most recently from 6de7cab to 3fb1b0a Compare July 30, 2025 08:00
@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch 2 times, most recently from 82c3e73 to abef54f Compare August 20, 2025 10:32
RayOffiah and others added 8 commits August 29, 2025 12:01
Add `asciidoctor-anywhere-footnote` to Antora playbook and update UI bundle to prod-213 Add `asciidoctor-anywhere-footnote` to Antora playbook and update UI bundle path for local build Add `anywhere-footnotes` example and link to navigation Upgrade `asciidoctor-anywhere-footnote` to ~1.2.7 and update dependencies in `package-lock.json`. Upgrade `asciidoctor-anywhere-footnote` to ~1.2.2 and update dependencies in `package-lock.json`. Upgrade `asciidoctor-anywhere-footnote` to ~1.2.1 and update dependencies in `package-lock.json`. Upgrade `asciidoctor-anywhere-footnote` to ~1.2.0 and update dependencies in `package-lock.json`. Add `asciidoctor-anywhere-footnote` to Antora preview playbook Upgrade `asciidoctor-anywhere-footnote` to ~1.1.9 and update dependencies in `package-lock.json`. Updated to include the correct URL for the UI bundle. The PR for the new UI bundle (couchbase/docs-ui#193) should be reviewed first so we know the number of the bundle. Upgrade `asciidoctor-anywhere-footnote` to ~1.1.8 and update dependencies in `package-lock.json`. Updating package.json Adding the anywhere-footnote extension
Test is failing due to ID being randomly auto-generated. Will see if that feature can be suppressed, as it's desirable for static site generator to be deterministic.
Update footnote markers in `anywhere-footnotes` example to remove brackets and improve readability. Update UI bundle URL to `adding-anywhere-footnote-13` in Antora preview playbook Upgrade `asciidoctor-anywhere-footnote` to ~1.3.2 and update dependencies in `package-lock.json`. Upgrade `asciidoctor-anywhere-footnote` to ~1.3.1, update footnote structure in `anywhere-footnotes` example, and remove the unused `randomstring` dependency Add `refid` attributes to footnotes in `anywhere-footnotes` example. This is to ensure that the unit tests don't need to worry about the random strings that are usually applied to the footnote references.
@RayOffiah RayOffiah force-pushed the adding-anywhere-footnote branch from abef54f to a4bfb35 Compare August 29, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants