Skip to content

Commit

Permalink
docs: make localhost links clickable (#7582)
Browse files Browse the repository at this point in the history
* docs: clickable localhost links

* revert changes in auto-generated examples folder

Co-authored-by: dht <dht@users.noreply.github.com>
  • Loading branch information
dht and dht committed Jun 8, 2022
1 parent 7869e74 commit 5c9e4a2
Show file tree
Hide file tree
Showing 17 changed files with 21 additions and 21 deletions.
Expand Up @@ -31,4 +31,4 @@ Congratulations, you have made your first post!
Feel free to play around and edit this post as much you like.
```

A new blog post is now available at `http://localhost:3000/blog/greetings`.
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
Expand Up @@ -20,7 +20,7 @@ Create a markdown file at `docs/hello.md`:
This is my **first Docusaurus document**!
```

A new document is now available at `http://localhost:3000/docs/hello`.
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).

## Configure the Sidebar

Expand Down
Expand Up @@ -28,7 +28,7 @@ export default function MyReactPage() {
}
```

A new page is now available at `http://localhost:3000/my-react-page`.
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).

## Create your first Markdown Page

Expand All @@ -40,4 +40,4 @@ Create a file at `src/pages/my-markdown-page.md`:
This is a Markdown page
```

A new page is now available at `http://localhost:3000/my-markdown-page`.
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
Expand Up @@ -26,6 +26,6 @@ Test your production build locally:
npm run serve
```

The `build` folder is now served at `http://localhost:3000/`.
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).

You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
Expand Up @@ -39,7 +39,7 @@ Start your site on the French locale:
npm run start -- --locale fr
```

Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.

:::caution

Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/creating-pages.md
Expand Up @@ -51,7 +51,7 @@ export default function Hello() {
}
```

Once you save the file, the development server will automatically reload the changes. Now open `http://localhost:3000/helloReact` and you will see the new page you just created.
Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created.

Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear.

Expand All @@ -77,7 +77,7 @@ hide_table_of_contents: true
How are you?
```

In the same way, a page will be created at `http://localhost:3000/helloMarkdown`.
In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown).

Markdown pages are less flexible than React pages because it always uses the theme layout.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/i18n/i18n-crowdin.mdx
Expand Up @@ -288,7 +288,7 @@ Start your site on the French locale:
npm run start -- --locale fr
```

Make sure that your website is now translated in French at `http://localhost:3000/fr/`.
Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/).

### Automate with CI {#automate-with-ci}

Expand Down
2 changes: 1 addition & 1 deletion website/docs/i18n/i18n-tutorial.md
Expand Up @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice:
npm run start -- --locale fr
```

Your site is accessible at **`http://localhost:3000/fr/`**.
Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/).

We haven't provided any translation yet, so the site is mostly untranslated.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/introduction.md
Expand Up @@ -36,7 +36,7 @@ cd my-website
npx docusaurus start
```

Open `http://localhost:3000` and follow the tutorial.
Open [http://localhost:3000](http://localhost:3000) and follow the tutorial.

:::tip

Expand Down
Expand Up @@ -51,7 +51,7 @@ export default function Hello() {
}
```

Once you save the file, the development server will automatically reload the changes. Now open `http://localhost:3000/helloReact` and you will see the new page you just created.
Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created.

Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear.

Expand All @@ -77,7 +77,7 @@ hide_table_of_contents: true
How are you?
```

In the same way, a page will be created at `http://localhost:3000/helloMarkdown`.
In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown).

Markdown pages are less flexible than React pages because it always uses the theme layout.

Expand Down
Expand Up @@ -287,7 +287,7 @@ Start your site on the French locale:
npm run start -- --locale fr
```

Make sure that your website is now translated in French at `http://localhost:3000/fr/`.
Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/).

### Automate with CI {#automate-with-ci}

Expand Down
Expand Up @@ -74,7 +74,7 @@ Start your localized site in dev mode, using the locale of your choice:
npm run start -- --locale fr
```

Your site is accessible at **`http://localhost:3000/fr/`**.
Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/).

We haven't provided any translation yet, so the site is mostly untranslated.

Expand Down
Expand Up @@ -36,7 +36,7 @@ cd my-website
npx docusaurus start
```

Open `http://localhost:3000` and follow the tutorial.
Open [http://localhost:3000](http://localhost:3000) and follow the tutorial.

:::tip

Expand Down
Expand Up @@ -51,7 +51,7 @@ export default function Hello() {
}
```

Once you save the file, the development server will automatically reload the changes. Now open `http://localhost:3000/helloReact` and you will see the new page you just created.
Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created.

Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear.

Expand All @@ -77,7 +77,7 @@ hide_table_of_contents: true
How are you?
```

In the same way, a page will be created at `http://localhost:3000/helloMarkdown`.
In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown).

Markdown pages are less flexible than React pages because it always uses the theme layout.

Expand Down
Expand Up @@ -287,7 +287,7 @@ Start your site on the French locale:
npm run start -- --locale fr
```

Make sure that your website is now translated in French at `http://localhost:3000/fr/`.
Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/).

### Automate with CI {#automate-with-ci}

Expand Down
Expand Up @@ -74,7 +74,7 @@ Start your localized site in dev mode, using the locale of your choice:
npm run start -- --locale fr
```

Your site is accessible at **`http://localhost:3000/fr/`**.
Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/).

We haven't provided any translation yet, so the site is mostly untranslated.

Expand Down
Expand Up @@ -36,7 +36,7 @@ cd my-website
npx docusaurus start
```

Open `http://localhost:3000` and follow the tutorial.
Open [http://localhost:3000](http://localhost:3000) and follow the tutorial.

:::tip

Expand Down

0 comments on commit 5c9e4a2

Please sign in to comment.