FRESHMADE README
Develop
Here are a few things you’ll want to do to get rolling with local development!
- Open this site in your Terminal app and run
./update.sh
, this will run through the configurations and help you get the correct Site Title, URL, and many more defaults set up for your website. It will also change this README’s header 😉 - While you’re in there run
npm install -g jekyll-bliss
as that’s the build/development tool - As Jekyll is a Rails app you will also want to run
bundle install
to install the proper gems you need.
Okay, prerequisites out of the way, now you can fire up the app and get rolling on local development if you’d like!
To get started with local development you’ll want to run bliss serve
or bliss s
if you’re lazy (it’s okay, I’m lazy too).
If you need any reference to the languages used in this you can check out these websites!
- Pug (formerly Jade) - This is a markup pre-processer, like Sass/Less but for HTML! If you change this you’ll need to take out the Bliss stuff and go back to
bundle exec jekyll serve
- Sass - Feel free to convert to
SCSS
syntax, or evenPostCSS
/CSS
, it’s your website! - Jekyll - Static Site Generator
- Netlify - 💯 recommend this host.
- Netlify CMS - This will be handy for extending the site capabilities.
Deploy
There are a few steps, but let’s walk through them here. I will also keep an up-to-date document at devsurgeon.com/docs/deployment.
- First off, log in or sign up to GitHub* and create a new repo. You can make it a public repo or private, that’s up to you!
- Follow the instructions from GitHub on the
git init
setup for your fresh new website. - Next, you’ll want to head over to netlify.com and Sign Up! They’ll guide you through getting your newly created (and pushed to GitHub) repo up and running for free.
* You can also use Bitbucket or Gitlab, but there will need to be some modifications to the Netlify CMS config.
You can remove the symbolic link to the readme in
/pages/
any time, for now this is just a handy reference