-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
copy docs from previous release (fixes #114)
- Loading branch information
Showing
781 changed files
with
51,536 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
_site/* | ||
Gemfile.lock | ||
.DS_store | ||
.jekyll-cache | ||
.gem | ||
.bundle | ||
|
||
*.gem | ||
*.sublime-project | ||
*.sublime-workspace | ||
.bundle | ||
.DS_Store | ||
.jekyll-cache | ||
.jekyll-metadata | ||
.sass-cache | ||
_asset_bundler_cache | ||
codekit-config.json | ||
node_modules | ||
npm-debug.log* | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
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 "github-pages", group: :jekyll_plugins | ||
|
||
# To upgrade, run `bundle update`. | ||
|
||
gem "jekyll" | ||
gem "minimal-mistakes-jekyll" | ||
|
||
# The following plugins are automatically loaded by the theme-gem: | ||
# gem "jekyll-paginate" | ||
# gem "jekyll-sitemap" | ||
# gem "jekyll-gist" | ||
# gem "jekyll-feed" | ||
# gem "jekyll-include-cache" | ||
# | ||
|
||
|
||
# If you have any other plugins, put them here! | ||
group :jekyll_plugins do | ||
|
||
gem 'jemoji', '~> 0.5.1' | ||
|
||
end | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2013-2019 Michael Rose and contributors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Jekyll Local Installation | ||
|
||
## Prerequisites | ||
|
||
### Installing Ruby on Ubuntu | ||
|
||
First of all, we need to install all the dependencies typing: | ||
|
||
```bash | ||
sudo apt-get install ruby-full build-essential zlib1g-dev | ||
``` | ||
|
||
After that, we need to set up a gem installation directory for your user account. The following commands will add environment variables to your `~/.bashrc` file to configure the gem installation path. Run them now: | ||
|
||
```bash | ||
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc | ||
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc | ||
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc | ||
source ~/.bashrc | ||
``` | ||
|
||
Finally, we install Jekyll: | ||
|
||
```bash | ||
gem install jekyll bundler | ||
``` | ||
|
||
Notice that we don't use the `root` user :-) | ||
|
||
### Installing Ruby and Jekyll on Mac OS X | ||
|
||
Follow the Jekyll [page installation guide](https://jekyllrb.com/docs/installation/macos/). | ||
|
||
## Running Jekyll Serve | ||
|
||
By default, the Jekyll server is launched with the following command (which is the one indicated on your website). | ||
|
||
```bash | ||
bundle exec jekyll serve | ||
``` | ||
|
||
If in the process of building the server there is a dependency problem, for example, there is a missing library to install, it is **necessary to delete** the `Gemfile.lock` file so that it is rebuilt with the installed dependency. This list of dependencies is found in the `Gemfile` file (in Python it would be equivalent to the `requirements.txt` file) and the version of each of the installed gems (packages) is specified. Having a list of dependencies is important for future updates as well as knowing the libraries needed to run the server. Once the `Gemfile.lock` file is deleted, the command shown above is launched again and the dependency errors should end. | ||
|
||
## Notes for exercise cards. | ||
|
||
- Teaser Images size: multiple of 600x400px | ||
|
||
|
||
## FAQ | ||
|
||
- Error building Jekyll server: | ||
|
||
```bash | ||
jekyll build --incremental --verbose | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
require "bundler/gem_tasks" | ||
require "jekyll" | ||
require "listen" | ||
|
||
def listen_ignore_paths(base, options) | ||
[ | ||
/_config\.ya?ml/, | ||
/_site/, | ||
/\.jekyll-metadata/ | ||
] | ||
end | ||
|
||
def listen_handler(base, options) | ||
site = Jekyll::Site.new(options) | ||
Jekyll::Command.process_site(site) | ||
proc do |modified, added, removed| | ||
t = Time.now | ||
c = modified + added + removed | ||
n = c.length | ||
relative_paths = c.map{ |p| Pathname.new(p).relative_path_from(base).to_s } | ||
print Jekyll.logger.message("Regenerating:", "#{relative_paths.join(", ")} changed... ") | ||
begin | ||
Jekyll::Command.process_site(site) | ||
puts "regenerated in #{Time.now - t} seconds." | ||
rescue => e | ||
puts "error:" | ||
Jekyll.logger.warn "Error:", e.message | ||
Jekyll.logger.warn "Error:", "Run jekyll build --trace for more information." | ||
end | ||
end | ||
end | ||
|
||
task :preview do | ||
base = Pathname.new('.').expand_path | ||
options = { | ||
"source" => base.join('test').to_s, | ||
"destination" => base.join('test/_site').to_s, | ||
"force_polling" => false, | ||
"serving" => true, | ||
"theme" => "minimal-mistakes-jekyll" | ||
} | ||
|
||
options = Jekyll.configuration(options) | ||
|
||
ENV["LISTEN_GEM_DEBUGGING"] = "1" | ||
listener = Listen.to( | ||
base.join("_data"), | ||
base.join("_includes"), | ||
base.join("_layouts"), | ||
base.join("_sass"), | ||
base.join("assets"), | ||
options["source"], | ||
:ignore => listen_ignore_paths(base, options), | ||
:force_polling => options['force_polling'], | ||
&(listen_handler(base, options)) | ||
) | ||
|
||
begin | ||
listener.start | ||
Jekyll.logger.info "Auto-regeneration:", "enabled for '#{options["source"]}'" | ||
|
||
unless options['serving'] | ||
trap("INT") do | ||
listener.stop | ||
puts " Halting auto-regeneration." | ||
exit 0 | ||
end | ||
|
||
loop { sleep 1000 } | ||
end | ||
rescue ThreadError | ||
# You pressed Ctrl-C, oh my! | ||
end | ||
|
||
Jekyll::Commands::Serve.process(options) | ||
end |
Oops, something went wrong.