Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessesquires/template-jekyll-site
Template repository for Jekyll websites
https://github.com/jessesquires/template-jekyll-site
jekyll jekyll-blog jekyll-site
Last synced: about 2 months ago
JSON representation
Template repository for Jekyll websites
- Host: GitHub
- URL: https://github.com/jessesquires/template-jekyll-site
- Owner: jessesquires
- License: other
- Created: 2020-06-14T18:37:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-22T20:49:56.000Z (over 1 year ago)
- Last Synced: 2024-05-09T20:08:24.449Z (8 months ago)
- Topics: jekyll, jekyll-blog, jekyll-site
- Language: HTML
- Size: 3.16 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# template-jekyll-site [](https://github.com/jessesquires/template-jekyll-site/actions/workflows/ci.yml)
*Template repository for Jekyll websites*
## About
This repo contains default project files for Jekyll-based website projects.
## Setup
This setup mostly assumes that you are [building a site with Jekyll on NearlyFreeSpeech.net](https://www.jessesquires.com/blog/2017/09/10/building-a-site-with-jekyll-on-nfsn/), but can be easily adapted for other hosts.
## Requirements
- [Bundler](https://bundler.io)
- [NPM](https://www.npmjs.com)
## Dependencies
### Gems
- [jekyll](https://jekyllrb.com) ([Latest](https://github.com/jekyll/jekyll/releases/latest)) ([Cheat Sheet](https://learn.cloudcannon.com/jekyll-cheat-sheet/))
- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
- [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) or [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2)
#### Updating Gems
```bash
$ make update-bundle
```
### NPM packages
- [Bootstrap](https://getbootstrap.com) ([package](https://www.npmjs.com/package/bootstrap))
- [Bootstrap Icons](https://icons.getbootstrap.com) ([package](https://www.npmjs.com/package/bootstrap-icons))
#### Updating packages
```bash
$ make update-deps
```
## Usage
### Installation
```bash
$ git clone https://github.com/jessesquires/template-jekyll-site
$ cd template-jekyll-site/
$ make install
```
### Building the site
```bash
$ make
```
### Previewing the site locally
```bash
$ make preview
```
## Validation
### Feeds
- https://validator.w3.org/feed/
- https://json-feed-validator.herokuapp.com
### Markup
- https://validator.w3.org/nu/
### Structured Data
- https://cards-dev.twitter.com/validator
- https://www.opengraphcheck.com
- https://search.google.com/structured-data/testing-tool
## License
This work is released under the [CC0 1.0 Universal (CC0 1.0) license](https://creativecommons.org/publicdomain/zero/1.0/). See [`LICENSE`](https://github.com/techworkersco/techworkersco.github.io/blob/master/LICENSE).
All code is licensed under an [MIT License](https://opensource.org/licenses/MIT).