From 1f3f569f3ed2469574248adf6d4c046056d28ea5 Mon Sep 17 00:00:00 2001 From: Alex1304 Date: Mon, 7 Dec 2020 19:02:01 +0100 Subject: [PATCH] docs(v2): wrap section about custom domains in :::info (#3891) --- website/docs/deployment.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index bfdcfa02f813..9cce9cf5fa17 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -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: