Welcome to NorthStack Q&A Ask a Question - vote up the best the answer

NorthStack Questions & AnswersCategory: SpecialHow do I create a Jekyll site on NorthStack?

How do I create a Jekyll site on NorthStack?


According to the Jekyll Documentation

Jekyll is a simple, extendable, static site generator. You give it text written in your favorite markup language and it churns through layouts to create a static website. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more.

This sounds great! Can I create a Jekyll site on NorthStack? If so, how would I go about doing so?

2 Answers

For official instructions, see our documentation at the Jekyll/NorthStack Getting Started Guide

Jeff Matson Staff answered 3 years ago

Yes, it is possible to create a Jekyll site on NorthStack by creating a static NorthStack application. You’ll then need to configure Jekyll’s…
And set a destination parameter, and rebuild your application so that it deploys the static files into the proper NorthStack directory.
Lets walk through this step by step..
Step zero Some forethought…
How you set up your application tree is up to you, but for this example our tree will look something like this…

├── assets
├── bin
├── docker
├── jekyllOnNorthstack <– our NorthStack application
├── myJekyllSite <– or Jekyll application
├── src
├── tests
└── vendor

Where Jekyll resides within our NorthStack client.
Step three: Install NorthStack
Install NorthStack within the nsjekyllapp directory
Step two: Create a NorthStack application
Within your NorthStack directory create an Application on NorthStack
Step three: Install Jekyll
Lets install Jekyll within your NorthStack directory. The instructions can be pretty much be found here, but for MacOS users you may run into the following problem when running gem install jekyll bundler with the following error…
gem install jekyll bundler ERROR: While executing gem ... (Gem::FilePermissionError) You don't have write permissions for the /Library/Ruby/Gems/#.#.# directory.
There are a few options for fixing this issue, but for now we’ll cover the homebrew solution
brew install ruby
After install your terminal will suggest you do the following…
echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile
Which will give access to the ruby library from your current directory.
After this, you should be able to run the commands without issue…

  • gem install jekyll bundler
  • jekyll new myJekyllSite
  • cd myJekyllSite

at this point, you’ve installed Jekyll! If you run…
bundle exec jekyll serve
You should be able to view the site at You can run this if you’d like just to make sure Jekyll is working okay.
Step four: Configure Jekyll
Once you’re done checking things out stop the server (ctrl+c on MacOS) and look for your _config.yml

├── 404.html
├── Gemfile
├── Gemfile.lock
├── _config.yml
├── _posts
│   └── 2018-12-20-welcome-to-jekyll.markdown
├── about.md
└── index.md

we want to add the following line to our _config.yml file..
destination: ../jekyllOnNorthstack/app/public
above the # Build Settings line. ../jekyllOnNorthstack/app/public is the relative location of our NorthStack application’s public directory. This is where your site files need to be when deploying to NorthStack

Once that’s saved we should check everything is okay! The Jekyll doctor command checks for major or potential issues for us.
jekyll doctor

For this particular example, the issues shown seem okay. We can proceed to run Jekyll’s build command to deploy the necessary files to our NorthStack application…
jekyll build

Step Five: Is everything there?
Check your NorthStack application’s public directory, it should look something like this…

├── 404.html
├── about
│   └── index.html
├── assets
│   ├── main.css
│   └── minima-social-icons.svg
├── feed.xml
├── index.html
└── jekyll
└── update
└── 2018
└── 12
└── 20
└── welcome-to-jekyll.html

Step Six: Ready to deploy!
If everything looks okay you can go ahead and deploy!
northstack app:deploy "initial Jekyll release" jekyllOnNorthstack dev

NorthStack Staff answered 3 years ago