Netlify is an automated hosting platform for deploying websites. Its deploy previews feature is particularly useful for i.e., how would the final output of the documentation will change if the PR is mergedpreviewing documentation changes in a PR.
The sections below explains how to use Netlify in a project.
Caution: Netlify allows only 300 free build minutes per month. They use an unsavory practice of letting you exceed the limit silently and then sending you an invoice for the extra use. You will not be able to use Netlify again unless you pay (or get them to cancel the charge). Therefore, we caution you to use Netlify (if at all) during times you update documentation and only if you want to use Netlify Deploy Previews to help review such PRs.
Go to https://www.netlify.com/ and click
Sign Up. Next, click
GITHUB SIGN IN, enter your GitHub account details and authorize netlify.
After logging in, click
New site from Git.
You will then be brought to the setup page. Click
GitHub to link your repository to Netlify.
Pick your repository from the list.
Fill out the details as follows and then click
cd docs && bundle install && bundle exec jekyll build
cd docs && npm i markbind-cli -g && markbind build --baseUrl
For both Jekyll and MarkBind, omit the
cd docs && and
docs/ from the build command and the publish directory respectively if the documentation is in the root (i.e., not inside the
Once Netlify has completed building your project, you can now:
Detailshyperlink next to the Netlify test status.
If you don’t like the site name given by Netlify, you can change it as follows: