bcgov / bcgov/api-guidelines

Devhub Issue: BC Government API Guidelines [Problems with underscores in web page display]

Open
#32 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
34
Forks
10
PR merge metrics
No merged PRs in 30d

Description

> path: (do not delete) https://github.com/bcgov/api-guidelines/blob/master/government-of-british-columbia-api-guidelines.md
> (do not delete) devhub page: https://developer.gov.bc.ca/Data-and-APIs/BC-Government-API-Guidelines

## Devhub Content Issue

Some things aren't displayed correctly in the guidelines web page. The image below shows them:

![Screenshot from 2023-01-17 17-42-00](https://user-images.githubusercontent.com/105941480/213008194-df59e886-cfe1-4f2b-b9e3-efd1135496c8.png)

1. :heavy*exclamation*mark: is shown instead of :heavy_exclamation_mark:
2. \`*per*page\`_ is shown instead of *`per_page`*

### Suggested solution

1. Escape the underscores (`:heavy\_excalamation\_mark:`)
2.
1. Do not use italics there and everywhere else, if the code formatting can be deemed sufficient
2. Italicize using asterisks (``*`per_page`*``)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.