Skip to content
Snippets Groups Projects
Commit 71ba32e1 authored by EricFromCanada's avatar EricFromCanada
Browse files

Additional text fixes

parent ce947ae5
No related branches found
No related tags found
No related merge requests found
......@@ -6,18 +6,18 @@ nav_order: 2
# Configuration
Just the Docs has some specific configuration parameters that can be definied in your Jekyll site's `_config.yml` file.
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's `_config.yml` file.
## Search enabled
```yml
```yaml
# Enable or disable the site search
search_enabled: true
```
## Aux links
```yml
```yaml
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
......@@ -26,7 +26,7 @@ aux_links:
## Color scheme
```yml
```yaml
# Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark"
```
......
......@@ -28,7 +28,7 @@ To enable a color scheme, set the `color_scheme` parameter in your site's `_conf
#### Example
{: .no_toc }
```yml
```yaml
# Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark"
```
......@@ -68,6 +68,6 @@ $link-color: $blue-000;
// ...
```
_Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependancies to fail.
_Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependencies to fail.
---
......@@ -200,7 +200,7 @@ To add a auxiliary navigation item to your site (in the upper right on all pages
#### Example
{: .no_toc }
```yml
```yaml
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
......
......@@ -33,8 +33,8 @@ $ bundle exec just-the-docs rake search:init
This command creates the `search-data.json` file that Jekyll uses to create your search index. Alternatively, you can create the file manually in the `assets/js/` directory of your Jekyll site with this content:
```{% raw %}
---
```liquid
{% raw %}---
---
{
{% for page in site.html_pages %}"{{ forloop.index0 }}": {
......@@ -54,7 +54,7 @@ _Note: If you don't run this rake command or create this file manually, search w
In your site's `_config.yml`, enable search:
```yml
```yaml
# Enable or disable the site search
search_enabled: true
```
......
......@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
spec.authors = ["Patrick Marsceill"]
spec.email = ["patrick.marsceill@gmail.com"]
spec.summary = %q{A nice looking, high customizable, responsive Jekyll theme for documention with built-in search.}
spec.summary = %q{A nice looking, highly customizable, responsive Jekyll theme for documentation with built-in search.}
spec.homepage = "https://github.com/pmarsceill/just-the-docs"
spec.license = "MIT"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment