Guide to Creating Links in Github

Two methods have been used to create links in Github. One method is the “ref” style, e.g.

"Libraries can turn on title-level requests in [Settings > Circulation > Title level requests]({{< ref "settings_circulation.md#settings--circulation--title-level-requests" >}})",

an example taken from the Orchid Github documentation (Requests.md file). This method had a bug whereby the links were jumping to the default flower release (currently Poppy). However, this bug was fixed by Julian, and is now working properly again. If this issue is observed again, contact Julian or Ian about the problem.

The alternative method of creating links is the “relative” or “../" style, e.g.

Permission sets are defined by your library in [Settings \> Users \> Permission sets](../settings/settings_users/settings_users/#settings--users--permission-sets).

an example taken from the Orchid Github documentation (Users >_index.md file). This style of link will never “jump” into a different release.

To create a relative link, count back how many folder levels you need to go up the folder hierarchy. That will be the number of ../ 's that you need at the beginning of the relative link. To go from

https://poppy.docs.folio.org/docs/access/requests/requests/

to

https://poppy.docs.folio.org/docs/settings/settings_circulation/settings_circulation/#settings--circulation--circulation-rules

for example, you would do

[Some link text](../../../settings/settings_circulation/settings_circulation/#settings--circulation--circulation-rules).

Note that the link is enclosed in parentheses, and needs to be all lower-case and have no spaces.