HPCE/gitea-pages
HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

content update

Browse Source
This commit is contained in:
tomjohnson1492 2016-10-07 19:12:59 -07:00
parent b69693e0fb
commit 47160d82f1
2 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -3,3 +3,4 @@ _site/
.jekyll-metadata
_pdf
.idea/
.DS_Store

24
index.md
View File

@ -7,18 +7,22 @@ permalink: index.html
summary: These brief instructions will help you get started quickly with the theme. The other topics in this help provide additional information and detail about working with other aspects of this theme and Jekyll.
---
## Download the theme
## Build the Theme
Follow these instructions to build the theme.
### 1. Download the theme
First download or clone the theme from the [Github repo](https://github.com/tomjohnson1492/documentation-theme-jekyll). Most likely you won't be pulling in updates once you start customizing the theme, so downloading the theme (instead of cloning it) probably makes the most sense. In Github, click the **Clone or download** button, and then click **Download ZIP**.
## Install Jekyll
### 2. Install Jekyll
If you've never installed or run a Jekyll site locally on your computer, follow these instructions to install Jekyll:
* [Install Jekyll on Mac][mydoc_install_jekyll_on_mac]
* [Install Jekyll on Windows][mydoc_install_jekyll_on_windows]
## Install Bundler
### 3. Install Bundler
In case you haven't installed Bundler, install it:
@ -28,30 +32,30 @@ gem install bundler
You'll want [Bundler](http://bundler.io/) to make sure all the Ruby gems needed work well with your project. Bundler sorts out dependencies and installs missing gems or matches up gems with the right versions based on gem dependencies.
## Remove the Gemfiles
### 4. Option 1: Build the Theme (*without* the github-pages gem) {#option1}
The Gemfile is how project dependencies are managed. Although this project includes a Gemfile, this theme doesn't have any dependencies beyond core Jekyll. The Gemfile is used to specify gems needed for publishing on Github Pages. If you're not planning to have Github Pages build your Jekyll project, delete these two files from the theme's root directory:
Use this option if you're not planning to publish your Jekyll site using [Github Pages](https://pages.github.com/).
Bundler's Gemfile is how it specifies and manages project dependencies are managed. Although this project includes a Gemfile, this theme doesn't have any dependencies beyond core Jekyll. The Gemfile is used to specify gems needed for publishing on Github Pages. If you're not planning to have Github Pages build your Jekyll project, delete these two files from the theme's root directory:
* Gemfile
* Gemfile.lock
## Build the Project (not with the Github Pages gem)
If you've never run Jekyll on your computer (you can check with `jekyll --version`), you may need to install the jekyll gem:
```
gem install jekyll
```
Now run Jekyll serve (first change directories (`cd`) to where you downloaded the project):
Now run jekyll serve (first change directories (`cd`) to where you downloaded the project):
```
jekyll serve
```
## Build the Project (with the Github Pages gem)
### 4. Option 2: Build the Theme (*with* the github-pages gem) {#option2}
If you *are* in fact publishing on Github Pages, leave the Gemfile and Gemfile.lock files in the theme, along with the Github Pages gem specified in the Gemfile (`gem 'github-pages', group: :jekyll_plugins`). However, note that you cannot use the normal `jekyll serve` command with this gem due to dependency conflicts between the latest version of Jekyll and Github Pages (which are noted [briefly here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/).
If you *are* in fact publishing on Github Pages, leave the Gemfile and Gemfile.lock files in the theme.The Gemfile tells Jekyll to use the github-pages gem. **However, note that you cannot use the normal `jekyll serve` command with this gem due to dependency conflicts between the latest version of Jekyll and Github Pages** (which are noted [briefly here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/).
You need Bundler to resolve these dependency conflicts. Use Bundler to install all the needed Ruby gems: