Skip to content

Commit

Permalink
Improve publishing guide on Github Pages (#664)
Browse files Browse the repository at this point in the history
Docusaurus docs is confusing, it should be https://facebook.github.io/Docusaurus when referring to GitHub Pages URL, not the custom domain at https://docusaurus.io/
  • Loading branch information
endiliey authored and yangshun committed May 16, 2018
1 parent f315d02 commit c730bc7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/getting-started-publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ GIT_USER=<GIT_USER> \

> The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`.
You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://_username_.github.io/_projectName_, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the `gh-pages` branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works.
You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://_username_.github.io/_projectName_, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the `gh-pages` branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works.

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

Expand Down

0 comments on commit c730bc7

Please sign in to comment.