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.

Sign up for GitHub

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

docs(showroom): Add internal cross ref in links section #213

Merged
merged 2 commits into from
Apr 2, 2024
Merged

docs(showroom): Add internal cross ref in links section #213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
890faa4
dhoc(showroom): Add internal cross ref in links section
rbioteau Apr 2, 2024
34949ec
Merge branch 'master' into doc/add_anchor_in_showroom
benjaminParisel Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion preview-src/links.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
= Link between components
= Links
:page-editable: true

== Link between components

You can adding link between two components or between versions of the same component. To do it, you **must** use the `xref` syntax.

The general form of a xref is `xref:<version>@<component_name>:<module>:<page>#anchor` and some elements are optional (version, module and anchor).
Expand Down Expand Up @@ -28,3 +30,8 @@ The general form of a xref is `xref:<version>@<component_name>:<module>:<page>#a
|===

You can find more details in https://github.com/bonitasoft/bonita-documentation-site/blob/master/docs/content/CONTRIBUTING.adoc#adding-link-between-two-components-or-between-versions-of-the-same-component[our contributing documentation guide].

== Anchors to navigate inside the same document

Internal cross references can be defined using `<<anchor-id, My Anchor Name>>`. To define an anchor, use `[#anchor-id]` at the location you want to navigate.

Loading