Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[portal] Jump to anchors in Markdown documents does not work - Syntax bug #6659

Closed
marijatimovska opened this issue Dec 1, 2021 · 1 comment

Comments

@marijatimovska
Copy link

Current Behavior

By adding anchor points to a Markdown document and publishing the document to the portal in Gravitee, the reference/jump to the anchor points no longer works. When we reference the default auto-generated anchors like (#general-design-principles), the jump to the paragraph # Allgemeine Design-Prinzipien works. If there is a custom anchor it does not work.

Expected Behavior

If the anchor name is custom, such as "alg-1", it does not work. It works on GitHub and other tools, as this is the correct markdown syntax.

Steps to Reproduce (for bugs)

  1. Create or Import any API.
  2. Create a two test Markdown page and in one put this : Working Example
- [Einleitung](#einleitung)
  - [Vorwort](#vorwort)

<a name="einleitung"></a>

# Einleitung

Lorem ipusm...

<a name="vorwort"></a>

## Vorwort

Lorem ipusm...

Non-working example:

- [Allgemeine Design-Prinzipien](#alg)
  - [MUSS: API-First Ansatz verfolgen](#alg-1)


<a name="alg"></a>

# Allgemeine Design-Prinzipien

Lorem ipsum...

<a name="alg-1"></a>

## MUSS: API-First Ansatz verfolgen

Lorem ipsum

Lorem ipsum

  1. Go to the portal and compare both pages to see the differene

Your Environment

  • Version used: 3.10.7 on Docker-Desktop
  • Operating System and version: Windows 10
@apoddany apoddany added this to the APIM - 3.10.x milestone Dec 7, 2021
@a-cordier a-cordier self-assigned this Dec 14, 2021
a-cordier added a commit to gravitee-io/gravitee-api-management that referenced this issue Dec 15, 2021
Despite `name` attribute being deprecated for anchors,
the syntax is still valid on some platforms (such as
Github). Hence the patch.

see gravitee-io/issues#6659
gcusnieux pushed a commit to gravitee-io/gravitee-api-management that referenced this issue Dec 20, 2021
Despite `name` attribute being deprecated for anchors,
the syntax is still valid on some platforms (such as
Github). Hence the patch.

see gravitee-io/issues#6659
@mouligno
Copy link
Contributor

LGTM

@phiz71 phiz71 modified the milestones: APIM - 3.10.x, APIM - 3.10.9 Dec 23, 2021
@phiz71 phiz71 closed this as completed Dec 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
API Management
Awaiting triage
Development

No branches or pull requests

5 participants