search

bcgov / api-guidelines

BC Government API Guidelines
https://developer.gov.bc.ca/Data-and-APIs/BC-Government-API-Guidelines
Other
29 stars 10 forks source link

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

Open annibalsilva opened 1 year ago

annibalsilva commented 1 year ago

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

  1. :heavyexclamationmark: is shown instead of :heavy_exclamation_mark:
  2. `perpage`_ is shown instead of per_page

Suggested solution

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