Skip to content

Commit

Permalink
Merge pull request #5 from carlesloriente/v1.0.0-ready-to-roll
Browse files Browse the repository at this point in the history
Commit major changes
  • Loading branch information
carlesloriente authored Mar 28, 2024
2 parents a06cda0 + 2353b3e commit 0b8e917
Show file tree
Hide file tree
Showing 48 changed files with 829 additions and 510 deletions.
Binary file modified .jekyll-metadata
Binary file not shown.
40 changes: 27 additions & 13 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,37 @@
sitemap: false
---

<header class="masthead sechead" style="height:65px;background-color:lightcoral;"></header>
<main class="flex-shrink-0">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-10 mx-auto">
{% assign tag = page.title | sluggify %}
<article class="post">
<header class="post-header">
<h1 class="post-title">{{ page.title | escape }}</h1>
</header>

<section class="masthead sechead" style="background-color:lightcoral;">
<div class="container">
<div class="row">
<div class="mx-auto">
{% assign tag = page.title | sluggify %}
<div class="post-heading">
<h1>{{ page.title | escape }}</h1>
</div>
</div>
</div>
</div>
</section>
<section>
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-10 mx-auto">
<div class="post-content">
<p>Please check the <a href="/posts/index.html" hreflang="{{ site.lang }}" aria-label="Posts index">index of posts</a>, or browse the <a href="/tags/" hreflang="{{ site.lang }}" aria-label="tags cloud">tags cloud</a> for more content.</p>
</div>
</article>
</div>
</div>
</div>
</section>
<section>
<div class="container">
<div class="row">
<div class="fixed-bottom-footer">
<div style="height:400px;background-repeat:no-repeat;background-position:center;background-image: url('{{ page.background | prepend: site.baseurl | replace: '//', '/' }}');"></div>
</div>
</div>
</div>
</div>
<div style="height:400px;background-repeat:no-repeat;background-position:center;margin-bottom:-40px;background-image: url('{{ page.background | prepend: site.baseurl | replace: '//', '/' }}');"></div>
</section>
</main>
42 changes: 28 additions & 14 deletions 503.html
Original file line number Diff line number Diff line change
@@ -1,28 +1,42 @@
---
layout: default
title: Servuce unavailable
title: Service unavailable
permalink: /503.html
background: '/assets/images/503.webp'
sitemap: false
---

<header class="masthead sechead" style="height:65px;background-color:lightcoral;"></header>
<main class="flex-shrink-0">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-10 mx-auto">
{% assign tag = page.title | sluggify %}
<article class="post">
<header class="post-header">
<h1 class="post-title">{{ page.title | escape }}</h1>
</header>

<section class="masthead sechead" style="background-color:lightcoral;">
<div class="container">
<div class="row">
<div class="mx-auto">
{% assign tag = page.title | sluggify %}
<div class="post-heading">
<h1>{{ page.title | escape }}</h1>
</div>
</div>
</div>
</div>
</section>
<section>
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-10 mx-auto">
<div class="post-content">
<p>Please try again in a few minutes, or check the <a href="/posts/index.html" hreflang="{{ site.lang }}" aria-label="Posts index">index of posts</a>, or browse the <a href="/tags/" hreflang="{{ site.lang }}" aria-label="tags cloud">tags cloud</a> for more content.</p>
</div>
</article>
</div>
</div>
</div>
</section>
<section>
<div class="container">
<div class="row">
<div class="fixed-bottom-footer">
<div style="height:400px;background-repeat:no-repeat;background-position:center;background-image: url('{{ page.background | prepend: site.baseurl | replace: '//', '/' }}');"></div>
</div>
</div>
</div>
</div>
<div style="height:400px;background-repeat:no-repeat;background-position:center;margin-bottom:-40px;background-image: url('{{ page.background | prepend: site.baseurl | replace: '//', '/' }}');"></div>
</section>
</main>
21 changes: 0 additions & 21 deletions LICENSE.md

This file was deleted.

121 changes: 71 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,121 @@
# Nocc bootstrap theme jekyll website
# NOCC Jekyll Bundle

[NOCC Bootstrap theme](https://bootstrap-theme.notesoncloudcomputing.com/). A responsive blog theme for [Bootstrap 5](https://getbootstrap.com/){:target="_blank"} created by [Carles Loriente](https://github.com/carlesloriente). Featuring a homepage, about page, tags cloud page, gallery of images page, examples post pages, post comments powered by [Disqus](https://disqus.com/){:target="_blank"} , and contact page form powered by [Formspree](https://formspree.io/){:target="_blank"} .
![NOCC Jekyll Bundle webshots](/assets/images/nocc-showcase.webp)

## Features

1. **Static site for host in github-pages**
2. **Use of Bootstrap 5 library**
3. **Critical Path CSS integrated**
4. **Self-hosted google webfonts**
5. **Local environment built-in**
6. **Extensive use of SVG and WebP**

**[More details: https://bootstrap-theme.notesoncloudcomputing.com/](https://bootstrap-theme.notesoncloudcomputing.com/)
[NOCC Jekyll Bundle](https://bootstrap-theme.notesoncloudcomputing.com/). A fully featured bundle site for [Jekyll](https://jekyllrb.com/){:target="_blank"} created by [Carles Loriente](https://github.com/carlesloriente).
Features a homepage, about page, tags cloud page, gallery of images page, examples post pages with comments powered by [Disqus](https://disqus.com/){:target="_blank"} and a contact form powered by [Formspree](https://formspree.io/){:target="_blank"}.
Using the [NOCC Bootstrap theme](https://www.npmjs.com/nocc-bootstrap-theme) npm package.

## Preview

[![NOCC Bootstrap theme Preview](https://www.notesoncloudcomputing.com/assets/images/screenshot.png)](https://bootstrap-theme.notesoncloudcomputing.com/)
## Features

**[View Live Website](https://www.notesoncloudcomputing.com){:target="_blank"}**
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**

## How it works

## Installation & Configuration

Demo images, posts, and pages are all included with the download. After following the instructions below, you can then go and change the content of the pages and posts.
Just follow the instructions below, and then you can change the content of the pages and site settings.

1. Clone this project or [download the package](https://github.com/carlesloriente/bootstrap-theme-jekyll/archive/gh-pages.zip).
1. [Download the package](https://github.com/carlesloriente/bootstrap-theme-jekyll/archive/refs/heads/main.zip) or clone the project running the command:

```bash
git clone --recursive git@github.com:carlesloriente/nocc-bootstrap-theme.git
git clone --recursive git@github.com:carlesloriente/bootstrap-theme-jekyll.git
```

2. Install the Nocc npm package
2. Install the NOCC npm package, run the command:

```bash
npm install nocc-bootstrap-theme --save
```

3. Update the following configuration settings in the `_config.yml` file:
- `landing` (Custom setting for the theme landing site, set fo `false`)
3. Install Ruby Gems and other dependencies, run the command:

```bash
sh bin/install.sh
```

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` (Custom setting for the theme landing site, set fo `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 page form create a free account at [Formspree](https://formspree.io){:target="_blank"})
- `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](https://disqus.com){:target="_blank"}, and fill in with your disqus shortname, if not needed, comment it out)
- `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](https://formspree.io){:target="_blank"})
- `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](https://disqus.com){:target="_blank"}, and fill in with your Disqus shortname, if not needed; comment it out)

### Add your content

For new posts/articles, you need to create these inside the folder named `_blog`, the files should be markdown format. Use one of the sample files provided to see the format and [Front Matter](https://jekyllrb.com/docs/front-matter/) settings. Remove the unwanted files.
You need to create new posts/articles inside the folder named `_blog`. The files should be in markdown format. Use one of the sample files to learn more about the syntax and [Front Matter](https://jekyllrb.com/docs/front-matter/) settings. Remove the unwanted files.

### Test your site locally

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

#### Configure local environment

#### Use the Local environment setup
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.

You can just use the jekyll web server command: `bundle exec jekyll serve`, or setup the local environment:
Navigate to folder `bin/certs` and execute the following command to validate certs and update the CA trust DB.

- Add `127.0.0.1 bootstrap-theme.local` to your /etc/hosts.
- Execute the command `sh bin/build-local.sh`, which will build the site files, launch Webrick webserver using the `_site_local` folder as webroot, and open your browser.
```bash
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`.

> [!IMPORTANT]
> Check this gist to create your own CA and wildcard cert.
### Host your site

#### in GitHub-Pages

Install certs.
You can host your site using GitHub Pages. Follow the [official guide](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).

### Publish your site
> [!IMPORTANT]
> GitHub Pages hosting is free; you need an account and repository.
#### to GitHub-Pages
#### in Amazon S3 bucket

#### to Amazon S3
You can host the site using an S3 Bucket; please follow the [AWS guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html).

## Bugs and Issues

Have a bug or an issue with this template? [Open a new issue](https://github.com/carlesloriente/bootstrap-theme-jekyll/issues) here on GitHub!

## Contributing

New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/carlesloriente/bootstrap-theme-jekyll/blob/master/CONTRIBUTING.md) to get involved.

## About

NOCC Bootstrap theme was created by and is maintained by **[Carles Loriente](https://www.linkedin.com/in/carles-loriente/)**.
**[Carles Loriente](https://www.linkedin.com/in/carles-loriente/)** is the creator and maintainer of the NOCC Jekyll Bundle and the NOCC Bootstrap theme.

- [Linkedin](https://www.linkedin.com/in/carles-loriente)
- [Twitter](https://twitter.com/godarthvader)
- [GitHub](https://github.com/carlesloriente)

[Bootstrap 5](https://getbootstrap.com/) framework created by [Mark Otto](https://twitter.com/mdo) and [Jacob Thorton](https://twitter.com/fat).

## Comtributing

New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/carlesloriente/bootstrap-theme-jekyll/blob/master/CONTRIBUTING.md) to get involved.

## Copyright and License

Copyright (c) 2024 Carles Loriente. Code released under the [MIT](https://github.com/carlesloriente/bootstrap-theme-jekyll/blob/master/LICENSE) license.
Copyright (c) 2024 Carles Loriente. The code released under the [MIT](https://github.com/carlesloriente/bootstrap-theme-jekyll/blob/master/LICENSE) license.
Loading

0 comments on commit 0b8e917

Please sign in to comment.