Removed readme.txt file because Github made an update that makes it take precedence over the index.html file
This commit is contained in:
19
README.md
19
README.md
@ -1,19 +0,0 @@
|
|||||||
## Jekyll Documentation theme
|
|
||||||
|
|
||||||
Build the site to see the instructions for using it. Or just go here: [http://idratherbewriting.com/documentation-theme-jekyll/](http://idratherbewriting.com/documentation-theme-jekyll/)
|
|
||||||
|
|
||||||
## Running the site in Docker
|
|
||||||
|
|
||||||
You can also use Docker to directly build and run the site on your local machine. Just clone the repo and run the following from your working dir:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker build --no-cache -t mydocs .
|
|
||||||
```
|
|
||||||
|
|
||||||
Once the build is complete, you can mount and run the whole site as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -v "$PWD:/src" -p 4000:4000 mydocs serve -H 0.0.0.0
|
|
||||||
```
|
|
||||||
This is perhaps the easiest way to see how your site would actually look.
|
|
||||||
|
|
17
index.md
17
index.md
@ -35,7 +35,7 @@ You'll want [Bundler](http://bundler.io/) to make sure all the Ruby gems needed
|
|||||||
### 4. Option 1: Build the Theme (*without* the github-pages gem) {#option1}
|
### 4. Option 1: Build the Theme (*without* the github-pages gem) {#option1}
|
||||||
|
|
||||||
Use this option if you're not planning to publish your Jekyll site using [Github Pages](https://pages.github.com/).
|
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:**
|
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
|
||||||
@ -71,6 +71,21 @@ bundle exec jekyll serve
|
|||||||
|
|
||||||
If you want to shorten this long command, you can put this code in a file such as jekyll.sh (on a Mac) and then simply type `. jekyll.sh` to build Jekyll.
|
If you want to shorten this long command, you can put this code in a file such as jekyll.sh (on a Mac) and then simply type `. jekyll.sh` to build Jekyll.
|
||||||
|
|
||||||
|
## Running the site in Docker
|
||||||
|
|
||||||
|
You can also use Docker to directly build and run the site on your local machine. Just clone the repo and run the following from your working dir:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker build --no-cache -t mydocs .
|
||||||
|
```
|
||||||
|
|
||||||
|
Once the build is complete, you can mount and run the whole site as follows:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -v "$PWD:/src" -p 4000:4000 mydocs serve -H 0.0.0.0
|
||||||
|
```
|
||||||
|
This is perhaps the easiest way to see how your site would actually look.
|
||||||
|
|
||||||
## Configure the sidebar
|
## Configure the sidebar
|
||||||
|
|
||||||
There are several products in this theme. Each product uses a different sidebar. This is the essence of what makes this theme unique -- different sidebars for different product documentation. The idea is that when users are reading documentation for a specific product, the sidebar navigation should be specific to that product. (You can read more of my thoughts on why multiple sidebars are important in this [blog post](http://idratherbewriting.com/2016/03/23/release-of-documentation-theme-for-jekyll-50/).)
|
There are several products in this theme. Each product uses a different sidebar. This is the essence of what makes this theme unique -- different sidebars for different product documentation. The idea is that when users are reading documentation for a specific product, the sidebar navigation should be specific to that product. (You can read more of my thoughts on why multiple sidebars are important in this [blog post](http://idratherbewriting.com/2016/03/23/release-of-documentation-theme-for-jekyll-50/).)
|
||||||
|
BIN
pages/.DS_Store
vendored
BIN
pages/.DS_Store
vendored
Binary file not shown.
@ -84,4 +84,28 @@ public class ScannerAndKeyboard
|
|||||||
}
|
}
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
|
The theme has syntax highlighting specified in the configuration file as follows:
|
||||||
|
|
||||||
|
```
|
||||||
|
highlighter: rouge
|
||||||
|
```
|
||||||
|
|
||||||
|
The syntax highlighting is done via the css/syntax.css file.
|
||||||
|
|
||||||
|
## Available lexers
|
||||||
|
|
||||||
|
The keywords you must add to specify the highlighting (in the previous example, `ruby`) are called "lexers." You can search for "lexers." Here are some common ones I use:
|
||||||
|
|
||||||
|
* js
|
||||||
|
* html
|
||||||
|
* yaml
|
||||||
|
* css
|
||||||
|
* json
|
||||||
|
* php
|
||||||
|
* java
|
||||||
|
* cpp
|
||||||
|
* dotnet
|
||||||
|
* xml
|
||||||
|
* http
|
||||||
|
|
||||||
{% include links.html %}
|
{% include links.html %}
|
||||||
|
@ -421,6 +421,6 @@ And here is the result:
|
|||||||
|
|
||||||
## More resources
|
## More resources
|
||||||
|
|
||||||
For more examples and explanations, see this helpful post on tournemille.com: [How to create data-driven navigation in Jekyll](http://www.tournemille.com/blog/How-to-create-data-driven-navigation-in-Jekyll/).
|
For more examples and explanations, see this helpful post on tournemille.com: [How to create data-driven navigation in Jekyll](http://www.tournemille.com/blog/How-to-create-data-driven-navigation-in-Jekyll).
|
||||||
|
|
||||||
{% include links.html %}
|
{% include links.html %}
|
||||||
|
Reference in New Issue
Block a user