Skip to content

Commit

Permalink
Add initial blank theme.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosperate committed Oct 20, 2019
1 parent b91c94f commit 541858b
Show file tree
Hide file tree
Showing 11 changed files with 400 additions and 22 deletions.
136 changes: 114 additions & 22 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,85 @@
###########
# Project #
###########
.vscode/
.vagrant/
.sass-cache
_site

###########
# Node.js #
###########
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

########
# Ruby #
########
*.gem
*.rbc
/.config
Expand All @@ -10,25 +92,6 @@
/test/version_tmp/
/tmp/

# Used by dotenv library to load environment variables.
# .env

## Specific to RubyMotion:
.dat*
.repl_history
build/
*.bridgesupport
build-iPhoneOS/
build-iPhoneSimulator/

## Specific to RubyMotion (use of CocoaPods):
#
# We recommend against adding the Pods directory to your .gitignore. However
# you should judge for yourself, the pros and cons are mentioned at:
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
#
# vendor/Pods/

## Documentation cache and generated files:
/.yardoc/
/_yardoc/
Expand All @@ -42,9 +105,38 @@ build-iPhoneSimulator/

# for a library or gem, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# Gemfile.lock
# .ruby-version
# .ruby-gemset
Gemfile.lock
.ruby-version
.ruby-gemset

# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
.rvmrc

######################
# OS generated files #
######################
# macoOS
.DS_Store
.DS_Store?
.AppleDouble
.LSOverride
._*
.Spotlight-V100
.Trashes
Icon?

# Windows
Thumbs.db
ehthumbs.db
ehthumbs_vista.db
*.stackdump
[Dd]esktop.ini
$RECYCLE.BIN/
*.lnk

# Linux
*~
.fuse_hidden*
.directory
.Trash-*
.nfs*
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# frozen_string_literal: true

source "https://rubygems.org"
gemspec
61 changes: 61 additions & 0 deletions README.md
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).
35 changes: 35 additions & 0 deletions Vagrantfile
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
2 changes: 2 additions & 0 deletions _config.yml
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.
1 change: 1 addition & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ content }}
5 changes: 5 additions & 0 deletions _layouts/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: default
---

{{ content }}
5 changes: 5 additions & 0 deletions _layouts/post.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: default
---

{{ content }}
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
remote_theme: carlosperate/jekyll-theme-rtd
Loading

0 comments on commit 541858b

Please sign in to comment.