NOCC Jekyll Bundle

NOCC Jekyll Bundle. A fully featured bundle site for Jekyll created by Carles Loriente. Features a homepage, about page, tags cloud page, gallery of images page, examples post pages with comments powered by Disqus and a contact form powered by Formspree. Using the NOCC Bootstrap theme npm package.

Table of contents

• NOCC Jekyll Bundle
  • Table of contents
  • Features
  • Installation
    • Configuration
    • Add your content
    • Setup local environment
      • Use HTTPS
    • Host your site
      • in GitHub-Pages
      • in Amazon S3 bucket
  • Bugs and Issues
  • Contributing
  • Creator
  • Thanks
  • Copyright and License

Features

1. A complete website ready to roll out
2. It uses a theme build for Bootstrap 5
3. Local and remote environments built-in
4. Extensive use of SVG and WeBP
5. Static site with dynamic features

Installation

Just follow the instructions below, and then you can change the content of the pages and site settings.

• Download the package or clone the project running the command:

   git clone --recursive [email protected]:carlesloriente/bootstrap-theme-jekyll.git

• Install the NOCC npm package, run the command:

  npm install nocc-bootstrap-theme --save

• Install Ruby Gems and other dependencies, run the command:

  sh bin/install.sh

Configuration

1. Update with your settings the configuration file _config.yml:
   • landing (Setting for the theme landing site, please set to false)
   • title
   • author
   • url
   • timezone
   • description
   • full_description (Setting for the theme landing site, please set to false)
   • gh_repository (Optional; if not needed, comment it out)
   • email (Set to a working email address, and then if you want to enable the contact form, create a free account at Formspree)
   • formemail (fill in with your Formspree code; after that, fill out and send the form on the contact page, check your email and verify if you are receiving the messages)
   • twitter_username (Optional; if not needed, comment it out)
   • github_username (Optional; if not needed, comment it out)
   • facebook_username (Optional; if not needed, comment it out)
   • instagram_username (Optional; if not needed, comment it out)
   • linkedin_username (Optional; if not needed, comment it out)
   • kofi (Optional; if not needed, comment it out)
   • google_site_verification (Optional; if not needed, comment it out)
   • google_analytics (Optional; if not needed, comment it out)
   • disqus_shortname (To enable the comments feature, create a free account at Disqus, and fill in with your Disqus shortname, if not needed; comment it out)

Add your content

You need to create new posts/articles inside the folder named _posts. The files should be in markdown format. Use one of the sample files to learn more about the syntax and Front Matter settings. Remove the unwanted files.

⛔ Posts should be named YEAR-MONTH-DAY-title.MARKUP (Note the MARKUP extension, which is usually .md or .markdown).

Setup local environment

Use the Jekyll build and web server command bundle exec jekyll serve or set up the local development environment (recommended).

Use HTTPS

Suppose you want to use HTTPS in your environment and eliminate browser warnings when developing. In that case, the bundle comes with handy pre-generated certs.

Navigate to folder bin/certs and execute the following command to validate certs and update the CA trust DB.

  openssl verify -CAfile ca_selfsigned.crt wildcard.local.crt && sudo cp ca_selfsigned.crt /etc/pki/ca-trust/source/anchors/ && sudo update-ca-trust

• Modify your /etc/hosts file adding 127.0.0.1 bootstrap-theme.local. Depending on your setup, there will already be an entry for 127.0.0.1; add bootstrap-theme.local after the last argument.
• Execute the command sh bin/build-local.sh, which will build the site files, launch the Webrick web server using the _site_local folder as webroot, and open your browser.
• For the first time only, you must make your browser trust the wildcard domain cert.
  • Mozilla Firefox: After opening the URL https://bootstrap-theme.local:8000, the message "Warning: Potential Security Risk Ahead" is shown; click the Advanced button and then Accept Risk & Continue.

ⓘ Check this gist to create your own CA and wildcard cert.

Host your site

in GitHub-Pages

You can host your site using GitHub Pages. Follow the official guide.

ⓘ GitHub Pages hosting is free; you need an account and repository.

in Amazon S3 bucket

You can host the site using an S3 Bucket; please follow the AWS guide.

Bugs and Issues

Have a bug or an issue with this template? Open a new issue here on GitHub!

Contributing

New contributors are always welcome! Check out CONTRIBUTING.md to get involved.

Creator

Carles Loriente is the creator and maintainer of the NOCC Bootstrap theme.

• Linkedin
• Twitter
• GitHub

Thanks

Bootstrap 5 framework created by Mark Otto and Jacob Thorton.

Copyright and License

Copyright (c) 2024 Carles Loriente. The code released under the MIT license.