Skip to content

Commit

Permalink
docs: wrap section about custom domains in :::info
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex1304 authored Dec 7, 2020
1 parent e00e54a commit 18eb95a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/docs/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ First, modify your `docusaurus.config.js` and add the required params:
| `url` | URL for your GitHub Page's user/organization page. This is commonly https://_username_.github.io. |
| `baseUrl` | Base URL for your project. For projects hosted on GitHub pages, it follows the format "/_projectName_/". For https://github.com/facebook/docusaurus, `baseUrl` is `/docusaurus/`. |

:::info
In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment.

You may refer to GitHub Pages' documentation [User, Organization, and Project Pages](https://help.github.com/en/articles/user-organization-and-project-pages) for more details.
:::

Example:

Expand Down

0 comments on commit 18eb95a

Please sign in to comment.