README.md

TrustedLogin Documentation Site

This is the source for the TrustedLogin documentation site. It is built using Docusaurus 2.

The docs themselves are inside the /docs folder.

To release updates

Updates are automatically released upon commit to the main branch.

To release an update locally, run the following command:

GIT_USER=<GITHUB_USERNAME> npx docusaurus deploy

See the Docusaurus docs for more information.

Annoying errors when deploying manually

Node.js version not met

If you get the [ERROR] Minimum Node.js version not met :( error, you'll need to switch the Node version. Hopefully, you've already installed nvm. If not, do that first, then run:

nvm use 18

Error: Running "git push" command failed.

Does the GitHub user account you are using have push access to the repository?

The Docusaurus docs say to do this, but it doesn't always work. If you get the "git push" error, try this instead:

GIT_USER=<GITHUB_USERNAME> USE_SSH=true yarn deploy

Okay, that still didn't work? Instead of using USE_SSH, try this instead. Make sure you're using your Personal Access Token, not your password.

GIT_USER=<GITHUB_USERNAME> GIT_PASS=<GITHUB_PERSONAL_ACCESS_TOKEN> yarn deploy