Link to Pages

Internal Links

To create a link between pages, type in the name of your link between brackets "[ ]". As you start typing, internal page link options will appear.

The resulting Markdown will look like this:

And end up looking like this Introduction to users!

πŸ“˜

Internal links only work within one project.

If you link across multiple projects, you must use standard Markdown hyperlinks.

Anchor Links

All section headers include an anchor link. The format is #header-name. So for example this link will bring you back to this section:

External Links

Inline Linking
To link inline, type the text you want to link within brackets, "[x]", followed directly by the link URL parentheses, "(y)".

Links look like this in the Markdown editor:

And result in a link that looks like this: ReadMe

Reference-Style Linking
Reference-style linking allows you to give a link a number or "name" and refer to it multiple times.

For example, if I type in:

It looks like this:

When I first search something I look at Google then at Yahoo then MSN.

*If this isn't working you might want to check out Changing Page URL

Open Links in New Tab

To open an internal link in a new tab

<a href="doc:introduction" target="_blank">Introduction</a>

To open an external link in a new tab

<a href="https://www.google.com/" target="_blank">Google</a>

Validating Links

You can use several third-party tools to automatically find broken links you intend to fix, since ReadMe doesn't currently provide a tool for doing so. One simple option:

https://validator.w3.org/checklink. No login required. For the URL field, enter your doc's custom domain. Select Hide redirects and select Check linked documents recursively. Leave recursion depth blank.

Since the results show you only links that are broken, not on which pages those links occur or how many times the broken links occur, you may want to export your project to a folder on your local computer. Then you can use a text editor such as Notepad++ to search the exported folder to find out which Markdown pages contain the broken links. You can then fix the broken links in your project's dash.


Did this page help you?