-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b91c94f
commit 541858b
Showing
11 changed files
with
400 additions
and
22 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
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,4 @@ | ||
# frozen_string_literal: true | ||
|
||
source "https://rubygems.org" | ||
gemspec |
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 |
---|---|---|
@@ -1,2 +1,63 @@ | ||
# jekyll-theme-rtd | ||
|
||
Port of the Read the Docs theme to Jekyll to use with GitHub Pages. | ||
|
||
``` | ||
vagrant up | ||
vagrant ssh | ||
(in ssh session) > cd /vagrant && bundle exec jekyll serve --host 0.0.0.0 | ||
``` | ||
|
||
This is still a **Work-In-Progress** theme and things will **not** work well. | ||
|
||
----- | ||
|
||
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`. | ||
|
||
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site! | ||
|
||
TODO: Delete this and the text above, and describe your gem | ||
|
||
|
||
## Installation | ||
|
||
Add this line to your Jekyll site's `Gemfile`: | ||
|
||
```ruby | ||
gem "jekyll-theme-rtd" | ||
``` | ||
|
||
And add this line to your Jekyll site's `_config.yml`: | ||
|
||
```yaml | ||
theme: jekyll-theme-rtd | ||
``` | ||
And then execute: | ||
$ bundle | ||
Or install it yourself as: | ||
$ gem install jekyll-theme-rtd | ||
## Usage | ||
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets. | ||
## Contributing | ||
Bug reports and pull requests are welcome on GitHub at https://github.com/carlosperate/jekyll-theme-rtd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
## Development | ||
To set up your environment to develop this theme, run `bundle install`. | ||
|
||
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. | ||
|
||
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled. | ||
To add a custom directory to your theme-gem, please edit the regexp in `rtd.gemspec` accordingly. | ||
|
||
## License | ||
|
||
The theme is available as open source under the terms of the [MIT License](LICENSE). |
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,35 @@ | ||
Vagrant.configure("2") do |config| | ||
config.vm.box = "ubuntu/bionic64" | ||
|
||
# Adding a recognisable names to vagrant and the virtual machine | ||
config.vm.define "jekyll-theme-rtd" do |t| | ||
end | ||
config.vm.provider "virtualbox" do |v| | ||
v.name = "jekyll-theme-rtd" | ||
end | ||
|
||
# This Ubuntu image creates a ubuntu-bionic-18.04-cloudimg-console.log file | ||
# https://betacloud.io/get-rid-of-ubuntu-xenial-16-04-cloudimg-console-log/ | ||
config.vm.provider "virtualbox" do |vb| | ||
vb.customize [ "modifyvm", :id, "--uartmode1", "disconnected" ] | ||
end | ||
|
||
# Configure the network to access the server from the host localhost:4000 | ||
config.vm.network "forwarded_port", guest: 4000, host: 4000, host_ip: "127.0.0.1" | ||
config.vm.provider "virtualbox" do |vb| | ||
vb.memory = "2048" | ||
end | ||
config.vm.provision "shell", privileged: false, inline: <<-SHELL | ||
# Update the system | ||
sudo apt-get -y update | ||
sudo apt-get -y install ruby-full | ||
# Needed to build some gems | ||
sudo apt-get -y install build-essential zlib1g-dev | ||
sudo gem install bundler | ||
# Install Jekyll and mirrors the GitHub environment | ||
sudo gem install github-pages | ||
# Set up gem environment | ||
cd /vagrant | ||
bundle install | ||
SHELL | ||
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,2 @@ | ||
title: Read The Docs Jekyll Theme | ||
description: Port of the Read the Docs theme to Jekyll to use with GitHub Pages. |
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 @@ | ||
{{ content }} |
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,5 @@ | ||
--- | ||
layout: default | ||
--- | ||
|
||
{{ content }} |
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,5 @@ | ||
--- | ||
layout: default | ||
--- | ||
|
||
{{ content }} |
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 @@ | ||
remote_theme: carlosperate/jekyll-theme-rtd |
Oops, something went wrong.