3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 23:40:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Improve publishing guide on Github Pages (#664)

Browse source 
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/
This commit is contained in:
Endilie Yacop Sucipto 2018-05-16 09:55:42 +08:00 • committed by Yangshun Tay
parent f315d02e58
commit c730bc7bb7
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/getting-started-publishing.md
View file

@ -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.