Skip to main content

Docusaurus deploy

How to localhost​

  • cd my-website
  • npm run start

If you want to add new blog, docs​

  • You are gonna use main branch to add new pages.
  • gh-pages only using for static web view.
  • You need to build and deploy again.

How to use docusaurus with github pages?​

  1. npx create-docusaurus@latest folder_name
  2. Change organization name, project name etc.
    • Add gh-pages deployment branch, trailingslah:true 3.Install
    yarn install
  1. Build
    yarn build
  1. Create personal access token or SSH setup for github.
  2. Deploy with SSH or token.
USE_SSH=true yarn deploy
# or
GIT_USER=<gh_personal_access_token> yarn deploy
  1. Change github repository page view main to gh-pages from repository settings -> pages(left sidebar) -> branch 'gh-pages and /root than save.

How to update?​

  • yarn build
  • USE_SSH=true yarn deploy
  • or
  • GIT_USER=<gh_personal_access_token> yarn deploy or make a alias on the .zshrc:
alias dinodeploy="yarn build & USE_SSH=true yarn deploy"

and use only dinodeploy on your repository path

Additional Resource​