3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/docs/tutorial-publish-site.md
Jay Martin 05858f0e50 docs: add an HTTPS example for publish-gh-pages (#1736) 
* docs: add an HTTPS example for publish-gh-pages

I moved step 1 to step 2 so the terminal steps would be together. I added Git Bash, because `publish-gh-pages` worked for me in Git Bash but didn't work at the Windows command prompt. 

I added HTTPS to step 4 because, on my system, HTTPS worked for me but SSH didn't work. I changed <GIT_USER> to USERNAME and deleted the $ prompt, to be consistent with other examples in the tutorial.

* Update tutorial-publish-site.md
2019-08-02 02:40:25 -07:00

1.8 KiB
Raw Blame History

id title
tutorial-publish-site Publish the Site
Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

  1. Edit the file docusaurus-tutorial/website/siteConfig.js and fill in the following values:
const siteConfig = {
  ...
  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
  organizationName: 'USERNAME' // Your GitHub username.
  ...
}
  1. In Terminal or Git Bash, kill the web server by pressing Cmd+C or Ctrl+C.
  2. In the website directory, run npm run build or yarn build. The command generates a build directory inside the website directory, containing HTML files (and other file types) for all of your docs and other pages. Make sure the docusaurus-tutorial/website/build directory is successfully created before running the next step.
  3. Replace USERNAME with your GitHub username and run the following command.
GIT_USER=USERNAME CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages # SSH
# or
GIT_USER=USERNAME CURRENT_BRANCH=master npm run publish-gh-pages # HTTPS

The HTML files (and other file types) are pushed to the gh-pages branch of your repository: https://github.com/USERNAME/docusaurus-tutorial.

  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!

Note that when you run npm run start again, the baseUrl will now be part of the path.