Skip to content

Commit

Permalink
Update linking documentation for clarification. (#586)
Browse files Browse the repository at this point in the history
1. Includes examples of linking to methods.
2. Mentions that all links must be relative, and absolute links -do not work- (to my knowledge)
  • Loading branch information
fsargent authored Jan 27, 2022
1 parent 5f0d6fa commit 2298c97
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/Documentation/05-linking-between-articles.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ tags: []

# Linking Between Articles

## What
Create hyperlinks to other Markdown files to create additional navigation within your documentation. All links are relative to the current file.

Create hyperlinks to other Markdown files to create additional navigation within your documentation.
1. Select the **Markdown file** you wish to modify

## How
2. Right click the file you're linking to and select "Copy Relative Path." To reference an element from within the API specification, first build the relative path to the `api.yaml` or `api.json` file (ie `../reference/api.yaml`) and then the path to the API endpoint call. *Note: copying the path does not include the HTTP request method. You will need to append that yourself.*

1. Select the **Markdown file** you wish to modify

2. Input `[Display Text](Hyperlink URL/File Location)`
![image](https://user-images.githubusercontent.com/273880/151421911-63d8cc54-4407-493a-821d-d94ce07eaf13.png)


3. Input `[Display Text](Hyperlink URL/File Location)`

> Link to Markdown Example: `[API Design Quickstart Guide](../Design-and-Modeling/01-getting-started.md)`
> Example: `[API Design Quickstart Guide](../Design-and-Modeling/01-getting-started.md)`
> API Method Example: `[creating a verification](../reference/api.yaml/paths/~1verification-requests/post)`

0 comments on commit 2298c97

Please sign in to comment.