Github pages is an optional Github service which publishes pages directly from a Github repository. Using documentation with your repo, it creates a user-friendly website with the key information about your package. Here is an example from the dsTidyverseClient package. Creating a website using Github pages only requires a few steps.
For both the client- and server-side packages, run:
devtools::build_site()
In the file .Rbuildignore, below the existing entries add the line:
docs
Commit and push the changes to your remote repository.
settings/pages.Build and Deployment/branch, change 'None' to the name of the branch you want to build the documentation from. In dsExample and dsExampleClient we are building from the master branch, so we set this to master. You can chose to build from a separate branch if you have a different workflow./root to /docs. Click save.about section click the cog (settings button) and check 'Use your GitHub Pages website'. A link to the website will now be shown.Now repeat for the client-side repository.