MkDocs with SFTP (minimal configuration)

• MkDocs

1. Edit mkdocs.yml and docs/index.md, add more files if needed.
2. Add the pip package to requirements.txt . (Themes and plugins)
3. Select Settings for your GitHub project.
4. Select Secrets and variables in Secrets.
5. Select Actions
6. Select New repository secrets.
7. Add the following name and value:
   • SFTP_HOST: SFTP server name
   • SFTP_PORT: SFTP port number (optional)
   • FTP_SUSERNAME: SFTP user name
   • FTP_SPASSWORD: SFTP password (optional)
   • SFTP_PRIVATEKEY: SSH private key (optional)
   • SFTP_PASSPHASE: Passphase of SSH private key (optional)
   • SFTP_REMOTEDIR: Destination SFTP server directory
8. Commit to a GitHub project: git push

Please check with your FTP client before configuring.

Many of the build error are that you mistyped mkdocs.yml or you forgot to add the package to requirements.txt. Check the file change immediately before the error occurred.

This is often not a problem with this project. You should not open an issue for that.