How to attach an internal link in GitHub's README

Asked 2 years ago, Updated 2 years ago, 127 views

If you want to write GitHub's README in English, you can attach an internal link as follows:

##Table of content
- Usage (#usage)

## Usage 
Conceptetur Commodore Cursus Solicitudin Vehicula

However, in the case of Japanese, the URL is the one encoded in Japanese, so you cannot use the same method as in English.Of course, I think I can do it by doing the following, but I don't think it's cool to write HTML here even though I'm writing in Markdown.

## Contents
- [How to use] (#usage)

<h2id="usage">How-to</h2>
Conceptetur Commodore Cursus Solicitudin Vehicula


If I want to write like README in English, how can I attach an internal link in Japanese?Or do I have to write a part of it in HTML?

add
Based on your comments, it seems that the behavior around here differs depending on the browser, so I will add the situation in various browsers.As a result of verification, the internal link in Japanese will not work for WebKit.

OK:

  • Firefox 35.0
  • Firefox 37.0

NG:

  • Chrome 40.0
  • Chrome Canary 42.0
  • Safari 8.0

github markdown

2022-09-30 18:51

2 Answers

I experimented with GitHub, but if you put the parentheses in Japanese as shown below, the link will be properly attached.

example description:

#Link
- README (#README)
- [How to use it] (#How to use it)

## README

README

## how to use

how to use


2022-09-30 18:51

Capital letters are lowercase, some symbols are omitted or converted.
There's an explanation page like this!

Qiita Markdown Intra-Page Link Trap

I was in a lot of trouble too, so it was a very satisfying result!
I need to get used to it a little bit!!


2022-09-30 18:51

If you have any answers or tips


© 2024 OneMinuteCode. All rights reserved.