Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Fix unclickable links #19067

Merged
merged 1 commit into from
Oct 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/adding-an-rss-feed.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ The `output` field in your feed object allows you to customize the filename for

By default, feed is referenced in every page. You can customize this behavior by providing an extra field `match` of type `string`. This string will be used to build a `RegExp`, and this regular expression will be used to test the `pathname` of current page. Only pages that satisfied the regular expression will have feed reference included.

To see your feed in action, run `gatsby build && gatsby serve` and you can then inspect the content and URLs in your RSS file at `http://localhost:9000/rss.xml`.
To see your feed in action, run `gatsby build && gatsby serve` and you can then inspect the content and URLs in your RSS file at <http://localhost:9000/rss.xml>.

> NOTE: if your blog has custom permalinks, such as links with or without dates in them, you may need to [customize `gatsby-node.js`](https://github.com/gatsbyjs/gatsby-starter-blog/blob/master/gatsby-node.js#L57) to output the correct URLs in your RSS feed. [Get in touch with us](/contributing/how-to-contribute/) if you need any help!

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/adding-search-with-js-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Breaking down the code into smaller parts:
In order to get it working in your site, you would only need to import the newly created component to a page.
As you can see [in the example site](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-js-search/src/pages/index.js).

Run `gatsby develop` and if all went well, open your browser of choice and enter the url `http://localhost:8000` - you'll have a fully functional search at your disposal.
Run `gatsby develop` and if all went well, open your browser of choice and enter the url <http://localhost:8000> - you'll have a fully functional search at your disposal.

## JS-Search with a big dataset

Expand Down Expand Up @@ -571,7 +571,7 @@ Once again to get it to work on your site you would only need to copy over [the

And both the [template](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-js-search/src/templates/ClientSearchTemplate.js) and the [search component](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-js-search/src/components/ClientSearch.js).

Issuing `gatsby develop` again, and if all went without any issues one more time, open your browser of choice and enter the url `http://localhost:8000/search`, you'll have a fully functional search at your disposal coupled with Gatsby API.
Issuing `gatsby develop` again, and if all went without any issues one more time, open your browser of choice and enter the url <http://localhost:8000/search>, you'll have a fully functional search at your disposal coupled with Gatsby API.

Hopefully this rather extensive guide has shed some insights on how to implement client search using js-search.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/building-an-ecommerce-site-with-shopify.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ plugins: [

## Querying Shopify data and listing products

Open the Gatsby GraphiQL interface by visiting `http://localhost:8000/___graphql`. With at least one example product added into Shopify you should see several new types of nodes in the Explorer tab, like `allShopifyProduct`. To query all products in your store sorted by title, try running the query:
Open the Gatsby GraphiQL interface by visiting <http://localhost:8000/___graphql>. With at least one example product added into Shopify you should see several new types of nodes in the Explorer tab, like `allShopifyProduct`. To query all products in your store sorted by title, try running the query:

```graphql
{
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/centralizing-your-sites-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ module.exports = {

GraphQL can be used to query for information contained in the `siteMetadata` object located in your project's `gatsby-config.js`. In order to test this out, you can start the `default-starter-project` in development mode by running `npm run develop`.

Navigate to `http://localhost:8000/___graphql` in your browser to view the GraphiQL editor, which enables you to test GraphQL queries on the underlying APIs. Using the documentation explorer you can view the current GraphQL schema for your project, which is an invaluable resource during development.
Navigate to <http://localhost:8000/___graphql> in your browser to view the GraphiQL editor, which enables you to test GraphQL queries on the underlying APIs. Using the documentation explorer you can view the current GraphQL schema for your project, which is an invaluable resource during development.

Examining the available types in GraphQL you will notice that you can query `site`. This GraphQL type further returns the `siteMetadata` which needs to be accessed to create the dynamic navigation. At this point, it is useful if you know a little GraphQL in order to extract the menu links. If you are unfamiliar with GraphQL, there is some excellent documentation available at GraphQL's official website found [here](https://graphql.org/learn/) that you can use to brush up on your skills! The query below will return the menu links.

Expand Down Expand Up @@ -265,7 +265,7 @@ Header.defaultProps = {
export default Header
```

Starting the development server by running `npm run develop` and navigating to `http://localhost:8000` you should now see some dynamically generated menu links on your page.
Starting the development server by running `npm run develop` and navigating to <http://localhost:8000> you should now see some dynamically generated menu links on your page.

If you have made it this far, good job! You can now add new site links to your website dynamically by adding entries to the `gatsby-config.js` file.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/graphql-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This doc serves as a reference for GraphQL features built into Gatsby, including

## Getting started with GraphQL

GraphQL is available in Gatsby without a special install: a schema is automatically inferred and created when you run `gatsby develop` or `gatsby build`. When the site compiles, the data layer can be [explored](/docs/running-queries-with-graphiql/) at: `http://localhost:8000/___graphql`
GraphQL is available in Gatsby without a special install: a schema is automatically inferred and created when you run `gatsby develop` or `gatsby build`. When the site compiles, the data layer can be [explored](/docs/running-queries-with-graphiql/) at: <http://localhost:8000/___graphql>

## Sourcing data

Expand Down
30 changes: 15 additions & 15 deletions docs/docs/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export default AboutPage
```

3. Run `gatsby develop` to start the development server.
4. Visit your new page in the browser: `http://localhost:8000/about`
4. Visit your new page in the browser: <http://localhost:8000/about>

#### Additional resources

Expand Down Expand Up @@ -253,7 +253,7 @@ export default ({ pageContext: { dog } }) => (
)
```

5. Run `gatsby develop` and navigate to the path of one of the pages you created (like at `http://localhost:8000/Fido`) to see the data you passed it displayed on the page
5. Run `gatsby develop` and navigate to the path of one of the pages you created (like at <http://localhost:8000/Fido>) to see the data you passed it displayed on the page

#### Additional resources

Expand Down Expand Up @@ -883,7 +883,7 @@ path: /my-first-post
This is my first Gatsby post written in Markdown!
```

3. Start up the development server with `gatsby develop`, navigate to the GraphiQL explorer at `http://localhost:8000/___graphql`, and write a query to get all markdown data:
3. Start up the development server with `gatsby develop`, navigate to the GraphiQL explorer at <http://localhost:8000/___graphql>, and write a query to get all markdown data:

```graphql
{
Expand Down Expand Up @@ -975,7 +975,7 @@ export const pageQuery = graphql`
`
```

6. Run `gatsby develop` to restart the development server. View your post in the browser: `http://localhost:8000/my-first-post`
6. Run `gatsby develop` to restart the development server. View your post in the browser: <http://localhost:8000/my-first-post>

#### Additional resources

Expand Down Expand Up @@ -1178,7 +1178,7 @@ plugins: [

7. Run `gatsby develop` and make sure the site compiled successfully.

8. Query data with the [GraphiQL editor](/docs/introducing-graphiql/) at `https://localhost:8000/___graphql`. The Contentful plugin adds several new node types to your site, including every content type in your Contentful website. Your example space with a "Blog Post" content type produces a `allContentfulBlogPost` node type in GraphQL.
8. Query data with the [GraphiQL editor](/docs/introducing-graphiql/) at <https://localhost:8000/___graphql>. The Contentful plugin adds several new node types to your site, including every content type in your Contentful website. Your example space with a "Blog Post" content type produces a `allContentfulBlogPost` node type in GraphQL.

![the graphql interface, with a sample query outlined below](./images/recipe-sourcing-contentful-graphql.png)

Expand Down Expand Up @@ -1304,7 +1304,7 @@ export default ({ pageContext: { allPokemon } }) => (
```

3. Run `gatsby develop` to fetch the data, build pages, and start the development server.
4. View your homepage in a browser: `http://localhost:8000`
4. View your homepage in a browser: <http://localhost:8000>

#### Additional resources

Expand Down Expand Up @@ -1344,7 +1344,7 @@ module.exports = {
}
```

3. Start the development server with `gatsby develop`, and open the GraphiQL explorer at `http://localhost:8000/___graphql`. Under the Explorer tab, you should see new node types, such as `allBlockBlock` for Drupal blocks, and one for every content type in your Drupal site. For example, if you have a "Page" content type, it will be available as `allNodePage`. To query all "Page" nodes for their title and body, use a query like:
3. Start the development server with `gatsby develop`, and open the GraphiQL explorer at <http://localhost:8000/___graphql>. Under the Explorer tab, you should see new node types, such as `allBlockBlock` for Drupal blocks, and one for every content type in your Drupal site. For example, if you have a "Page" content type, it will be available as `allNodePage`. To query all "Page" nodes for their title and body, use a query like:

```graphql
{
Expand Down Expand Up @@ -1402,7 +1402,7 @@ export const query = graphql`
}
```

5. With the development server running, you can view the new page by visiting `http://localhost:8000/drupal`.
5. With the development server running, you can view the new page by visiting <http://localhost:8000/drupal>.

#### Additional Resources

Expand Down Expand Up @@ -1567,7 +1567,7 @@ To limit data, you'll need a Gatsby site with some nodes in the GraphQL data lay
#### Directions

1. Run `gatsby develop` to start the development server.
2. Open a tab in your browser at: `http://localhost:8000/___graphql`.
2. Open a tab in your browser at: <http://localhost:8000/___graphql>.
3. Add a query in the editor with the following fields on `allSitePage` to start off:

```graphql
Expand Down Expand Up @@ -1627,7 +1627,7 @@ For this recipe, you'll need a Gatsby site with a collection of nodes to sort in
#### Directions

1. Run `gatsby develop` to start the development server.
2. Open the GraphiQL explorer in a browser tab at: `http://localhost:8000/___graphql`
2. Open the GraphiQL explorer in a browser tab at: <http://localhost:8000/___graphql>
3. Add a query in the editor with the following fields on `allSitePage` to start off:

```graphql
Expand Down Expand Up @@ -1688,7 +1688,7 @@ For this recipe, you'll need a Gatsby site with a collection of nodes to filter
#### Directions

1. Run `gatsby develop` to start the development server.
2. Open the GraphiQL explorer in a browser tab at: `http://localhost:8000/___graphql`
2. Open the GraphiQL explorer in a browser tab at: <http://localhost:8000/___graphql>
3. Add a query in the editor using a field prefixed by 'all', like `allMarkdownRemark` (meaning that it will return a list of nodes)

```graphql
Expand Down Expand Up @@ -1748,7 +1748,7 @@ If you would like to run two queries on the same datasource, you can use an alia
#### Directions

1. Run `gatsby develop` to start the development server.
2. Open the GraphiQL explorer in a browser tab at: `http://localhost:8000/___graphql`
2. Open the GraphiQL explorer in a browser tab at: <http://localhost:8000/___graphql>
3. Add a query in the editor using two fields of the same name like `allFile`

```graphql
Expand Down Expand Up @@ -1878,7 +1878,7 @@ export default () => (
```

3. Run `gatsby develop` to start the development server.
4. View your image in the browser: `http://localhost:8000/`
4. View your image in the browser: <http://localhost:8000/>

#### Additional resources

Expand Down Expand Up @@ -1925,7 +1925,7 @@ export default () => (
```

3. Run `gatsby develop` to start the development server.
4. View your image in the browser: `http://localhost:8000/`
4. View your image in the browser: <http://localhost:8000/>

#### Additional resources

Expand Down Expand Up @@ -2279,7 +2279,7 @@ export const query = graphql`
`
```

3. Restart the development server and open GraphiQL at `http://localhost:8000/___graphql`. Explore the fields available on the `MarkdownRemark` node.
3. Restart the development server and open GraphiQL at <http://localhost:8000/___graphql>. Explore the fields available on the `MarkdownRemark` node.

#### Additional resources

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/schema-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ type AuthorJson implements Node {

> A quick way to inspect the schema generated by Gatsby is the GraphQL Playground.
> Start your project with `GATSBY_GRAPHQL_IDE=playground gatsby develop`, open the
> playground at `http://localhost:8000/___graphql` and inspect the `Schema` tab on
> playground at <http://localhost:8000/___graphql> and inspect the `Schema` tab on
> the right.

### Automatic type inference
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sourcing-content-from-json-or-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ After parsing a YAML file into data and configuring Gatsby to produce pages with
- gatsby-node.js
```

Running `gatsby develop` in the terminal and opening a browser window to `http://localhost:8000/page1` you'll see a page with content that was sourced from a YAML file used to generate your site.
Running `gatsby develop` in the terminal and opening a browser window to <http://localhost:8000/page1> you'll see a page with content that was sourced from a YAML file used to generate your site.

To make this work on your existing Gatsby site, you would need to:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sourcing-from-contentstack.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Navigate to your root directory and run the following command:

`gatsby develop`

After running this, you will be able to view your site at `http://localhost:8000/`. You can run the GraphiQL IDE at `http://localhost:8000/___graphql`. The GraphiQL IDE will help you explore the app's data, including the Contentstack APIs.
After running this, you will be able to view your site at <http://localhost:8000/>. You can run the GraphiQL IDE at <http://localhost:8000/___graphql>. The GraphiQL IDE will help you explore the app's data, including the Contentstack APIs.

Now, you will able to query Contentstack data. Try the query below to get the 'Home' content type data:

Expand Down Expand Up @@ -89,7 +89,7 @@ export const pageQuery = graphql`
`
```

This will display the title of your home page on `http://localhost:8000/home`. Likewise, you can query additional fields in your entry.
This will display the title of your home page on <http://localhost:8000/home>. Likewise, you can query additional fields in your entry.

## Closing Note

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/sourcing-from-gentics-mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Gentics Mesh is a self-hosted CMS. You can run it for example via [Docker](https
docker run -p 8080:8080 -d gentics/mesh-demo
```

The demo Gentics server that gets setup has a UI that can be accessed on `http://localhost:8080/mesh-ui/` with default login (username: admin, password: admin). It allows you to view the content stored on the CMS and add new content.
The demo Gentics server that gets setup has a UI that can be accessed on <http://localhost:8080/mesh-ui/> with default login (username: admin, password: admin). It allows you to view the content stored on the CMS and add new content.

### Install the boilerplate

Expand Down Expand Up @@ -67,7 +67,7 @@ If everything works correctly, you should now have your Gentics Mesh API added t

From the root of your project, run the development environment with `gatsby develop`. Once the server has started, you should be able to open the following URL in your browser:

`http://localhost:8000/___graphql`
<http://localhost:8000/___graphql>

This will show you an interface where you can test your new content GraphQL API.

Expand Down Expand Up @@ -180,7 +180,7 @@ const IndexPage = () => (
export default IndexPage
```

Once saved you can access the page via `http://localhost:8000`
Once saved you can access the page via <http://localhost:8000>

You now have:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sourcing-from-graphcms.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ If everything works correctly, you should now have your GraphCMS data added to t

From the root of your project, run the development environment with `gatsby develop`. Once the server has started and is error free, you should be able to open the following URL in your browser:

`http://localhost:8000/___graphql`
<http://localhost:8000/___graphql>

This will show you an interface where you can test your new content API.

Expand Down
Loading