Skip to content

Document absolute link syntax #411

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

Closed
wants to merge 1 commit into from
Closed

Document absolute link syntax #411

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion docs/syntax/links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ A link contains link text (the visible text) and a link destination (the URI tha

[**Hi**, _I'm md_](links.md)

## Link to another page

You can link to another page by pointing to the markdown file.
This applies to files within the same repo.

```markdown
[Link text](/solutions/search.md)
```

Note that they must be prefixed with `/`.
Copy link
Member

Choose a reason for hiding this comment

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

Links to other pages don't have to be prefixed with /. You can also link to other pages with relative links. For example:

[syntax guide](../syntax/index.md)

and

* [Transition from AsciiDoc to Markdown](./syntax.md)

Copy link
Member

Choose a reason for hiding this comment

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

I think you could update the example in ## Inline link section to include a relative and absolute link. The example of links.md is a bad one and should be replaced.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah agreed I'll open a fresh PR and try to clean up the whole page tomorrow

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bmorelli25 just for the absolute syntax, was operating off this statement https://elastic.slack.com/archives/C07APH4RCDT/p1738594924973629?thread_ts=1738594418.206959&cid=C07APH4RCDT


## Anchor link

You can link to a heading on a page with an anchor link. The link destination should be a `#` followed by the header text. Convert spaces to dashes (`-`).
Expand Down Expand Up @@ -102,4 +113,4 @@ Docsbuilder temporary supports the abbility to create a linkable anchor anywhere
This is text and $$$this-is-an-inline-anchor$$$
```

This feature exists to aid with migration however is scheduled for removal and new content should **NOT** utilize this feature.
This feature exists to aid with migration however is scheduled for removal and new content should **NOT** utilize this feature.