From 90a5e767b2cc9c72f22ed0052de7e73032c0ecfc Mon Sep 17 00:00:00 2001 From: Erika Rowland <130414394+erikareads@users.noreply.github.com> Date: Mon, 13 Jan 2025 06:15:23 -0800 Subject: [PATCH] copy jekyll example from vercel/vercel (#1019) --- framework-boilerplates/jekyll/.gitignore | 9 ++ framework-boilerplates/jekyll/404.html | 25 +++++ framework-boilerplates/jekyll/Gemfile | 32 +++++++ framework-boilerplates/jekyll/Gemfile.lock | 91 +++++++++++++++++++ framework-boilerplates/jekyll/README.md | 19 ++++ framework-boilerplates/jekyll/_config.yml | 55 +++++++++++ .../_posts/2021-02-19-welcome-to-jekyll.md | 30 ++++++ framework-boilerplates/jekyll/about.md | 17 ++++ framework-boilerplates/jekyll/index.md | 6 ++ 9 files changed, 284 insertions(+) create mode 100644 framework-boilerplates/jekyll/.gitignore create mode 100644 framework-boilerplates/jekyll/404.html create mode 100644 framework-boilerplates/jekyll/Gemfile create mode 100644 framework-boilerplates/jekyll/Gemfile.lock create mode 100644 framework-boilerplates/jekyll/README.md create mode 100644 framework-boilerplates/jekyll/_config.yml create mode 100644 framework-boilerplates/jekyll/_posts/2021-02-19-welcome-to-jekyll.md create mode 100644 framework-boilerplates/jekyll/about.md create mode 100644 framework-boilerplates/jekyll/index.md diff --git a/framework-boilerplates/jekyll/.gitignore b/framework-boilerplates/jekyll/.gitignore new file mode 100644 index 000000000..d8a51b2f1 --- /dev/null +++ b/framework-boilerplates/jekyll/.gitignore @@ -0,0 +1,9 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor +public +.env +.env.build +.vercel diff --git a/framework-boilerplates/jekyll/404.html b/framework-boilerplates/jekyll/404.html new file mode 100644 index 000000000..086a5c9ea --- /dev/null +++ b/framework-boilerplates/jekyll/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/framework-boilerplates/jekyll/Gemfile b/framework-boilerplates/jekyll/Gemfile new file mode 100644 index 000000000..2a00bded8 --- /dev/null +++ b/framework-boilerplates/jekyll/Gemfile @@ -0,0 +1,32 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +gem "jekyll", "~> 4.3.0" +# This is the default theme for new Jekyll sites. You may change this to anything you like. +gem "minima", "~> 2.5" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +# gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + +# Webrick not installed by default in Ruby 3.0+ +gem "webrick" diff --git a/framework-boilerplates/jekyll/Gemfile.lock b/framework-boilerplates/jekyll/Gemfile.lock new file mode 100644 index 000000000..e646c4a8f --- /dev/null +++ b/framework-boilerplates/jekyll/Gemfile.lock @@ -0,0 +1,91 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + bigdecimal (3.1.8) + colorator (1.1.0) + concurrent-ruby (1.3.3) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + eventmachine (1.2.7) + ffi (1.17.0) + forwardable-extended (2.6.0) + google-protobuf (4.27.3) + bigdecimal + rake (>= 13) + http_parser.rb (0.8.0) + i18n (1.14.5) + concurrent-ruby (~> 1.0) + jekyll (4.3.3) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-feed (0.17.0) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (6.0.1) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + rexml (3.3.4) + strscan + rouge (4.3.0) + safe_yaml (1.0.5) + sass-embedded (1.77.8) + google-protobuf (~> 4.26) + rake (>= 13) + strscan (3.1.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) + +PLATFORMS + ruby + +DEPENDENCIES + jekyll (~> 4.3.0) + jekyll-feed (~> 0.12) + minima (~> 2.5) + tzinfo (~> 1.2) + tzinfo-data + wdm (~> 0.1.1) + webrick + +BUNDLED WITH + 2.5.6 diff --git a/framework-boilerplates/jekyll/README.md b/framework-boilerplates/jekyll/README.md new file mode 100644 index 000000000..ce1b37094 --- /dev/null +++ b/framework-boilerplates/jekyll/README.md @@ -0,0 +1,19 @@ +# Jekyll Example + +This directory is a brief example of a [Jekyll](https://jekyllrb.com/) site that can be deployed to Vercel with zero configuration. + +## Deploy Your Own + +Deploy your own Jekyll project with Vercel. + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/examples/tree/main/framework-boilerplates/jekyll&template=jekyll) + +_Live Example: https://jekyll-template.vercel.app_ + +### How We Created This Example + +To get started with Jekyll for deployment with Vercel, you can use the [Jekyll CLI](https://jekyllrb.com/docs/usage/) to initialize the project: + +```shell +$ jekyll new my-blog +``` diff --git a/framework-boilerplates/jekyll/_config.yml b/framework-boilerplates/jekyll/_config.yml new file mode 100644 index 000000000..ef7ba7c13 --- /dev/null +++ b/framework-boilerplates/jekyll/_config.yml @@ -0,0 +1,55 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. +# +# If you need help with YAML syntax, here are some quick references for you: +# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml +# https://learnxinyminutes.com/docs/yaml/ +# +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. + +title: Your awesome title +email: your-email@example.com +description: >- # this means to ignore newlines until "baseurl:" + Write an awesome description for your new site here. You can edit this + line in _config.yml. It will appear in your document head meta (for + Google search results) and in your feed.xml site description. +baseurl: "" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com +twitter_username: jekyllrb +github_username: jekyll + +# Build settings +theme: minima +plugins: + - jekyll-feed + +# Exclude from processing. +# The following items will not be processed, by default. +# Any item listed under the `exclude:` key here will be automatically added to +# the internal "default list". +# +# Excluded items can be processed by explicitly listing the directories or +# their entries' file path in the `include:` list. +# +# exclude: +# - .sass-cache/ +# - .jekyll-cache/ +# - gemfiles/ +# - Gemfile +# - Gemfile.lock +# - node_modules/ +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/framework-boilerplates/jekyll/_posts/2021-02-19-welcome-to-jekyll.md b/framework-boilerplates/jekyll/_posts/2021-02-19-welcome-to-jekyll.md new file mode 100644 index 000000000..26ac78c57 --- /dev/null +++ b/framework-boilerplates/jekyll/_posts/2021-02-19-welcome-to-jekyll.md @@ -0,0 +1,30 @@ +--- +layout: post +title: 'Welcome to Jekyll!' +date: 2021-02-19 23:17:16 +0000 +categories: jekyll update +--- + +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. + +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) +puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. + +[jekyll-docs]: https://jekyllrb.com/docs/home +[jekyll-gh]: https://github.com/jekyll/jekyll +[jekyll-talk]: https://talk.jekyllrb.com/ diff --git a/framework-boilerplates/jekyll/about.md b/framework-boilerplates/jekyll/about.md new file mode 100644 index 000000000..33808e90d --- /dev/null +++ b/framework-boilerplates/jekyll/about.md @@ -0,0 +1,17 @@ +--- +layout: page +title: About +permalink: /about/ +--- + +This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) + +You can find the source code for Minima at GitHub: +[jekyll][jekyll-organization] / +[minima](https://github.com/jekyll/minima) + +You can find the source code for Jekyll at GitHub: +[jekyll][jekyll-organization] / +[jekyll](https://github.com/jekyll/jekyll) + +[jekyll-organization]: https://github.com/jekyll diff --git a/framework-boilerplates/jekyll/index.md b/framework-boilerplates/jekyll/index.md new file mode 100644 index 000000000..067150784 --- /dev/null +++ b/framework-boilerplates/jekyll/index.md @@ -0,0 +1,6 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: home +---