From fc0d7a84dbbb937bb35f6746ef75a7d5fc5c9734 Mon Sep 17 00:00:00 2001 From: ooxi Date: Sun, 24 Jul 2022 23:56:54 +0200 Subject: [PATCH] Fix link rendering for correct display in GitHub (#1666) Unfortunately, GitHub does not render `[file]` as a link to `file`. Instead, `[file](file)` is required. This patch fixes the rendering of [utils/highlightjs](https://github.com/carbon-language/carbon-lang/tree/trunk/utils/highlightjs) --- utils/highlightjs/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/utils/highlightjs/README.md b/utils/highlightjs/README.md index e3307335e9d5..f88354b0719c 100644 --- a/utils/highlightjs/README.md +++ b/utils/highlightjs/README.md @@ -13,8 +13,8 @@ This directory collects syntax highlighting utilities for use with Carbon code. This JavaScript syntax highlighting system is used on webpages or in presentation software like [reveal.js](https://revealjs.com/). -The code is in [highlightjs_carbon_lang.js], and you can use it by registering -it after you load highlight.js: +The code is in [highlightjs_carbon_lang.js](highlightjs_carbon_lang.js), and you +can use it by registering it after you load highlight.js: ```html ``` -See [highlightjs_example.html] for a more complete example. +See [highlightjs_example.html](highlightjs_example.html) for a more complete +example. It includes many Carbon-specific markup indicators that may be useful to customize display or highlighting of Carbon code.