search

johnfernow / personal-website

My personal website
https://johnfernow.com
0 stars 0 forks source link

Update README.md #6

Closed johnfernow closed 4 years ago

johnfernow commented 5 years ago

Explain how to build site locally before committing, pushing and publishing. Should probably explain setup for installing and configuring Jekyll and list it as a dependency.

Also should mention that if the site looks different locally than when published, it's likely because GitHub is running a different version of Jekyll than what is installed locally. If that becomes too much of a hassle, the project can always switch to building locally and publishing it to a branch gh-pages, having a .nojekyll file so GitHub doesn't rebuild it.

Also maybe a brief description about what the website is about.

johnfernow commented 5 years ago

Also, include a requirements for merge requests, including things such as all external links that open in new tabs MUST include rel="noopener noreferrer" for security reasons.

johnfernow commented 4 years ago

Also include how to test it on other devices on the same network.