thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2025-01-21 23:36:29 -05:00
Code Issues Projects Releases Wiki Activity

Additional text fixes

Browse Source
This commit is contained in:
EricFromCanada 2019-01-15 20:43:19 -05:00
parent ce947ae543
commit 71ba32e131
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/configuration.md
View File

@ -6,18 +6,18 @@ nav_order: 2
# Configuration # 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 ## Search enabled
```yml ```yaml
# Enable or disable the site search # Enable or disable the site search
search_enabled: true search_enabled: true
``` ```
## Aux links ## Aux links
```yml ```yaml
# Aux links for the upper right navigation # Aux links for the upper right navigation
aux_links: aux_links:
"Just the Docs on GitHub": "Just the Docs on GitHub":
@ -26,7 +26,7 @@ aux_links:
## Color scheme ## Color scheme
```yml ```yaml
# Color scheme currently only supports "dark" or nil (default) # Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark" color_scheme: "dark"
``` ```

4
docs/customization.md
View File

@ -28,7 +28,7 @@ To enable a color scheme, set the `color_scheme` parameter in your site's `_conf
#### Example #### Example
{: .no_toc } {: .no_toc }
```yml ```yaml
# Color scheme currently only supports "dark" or nil (default) # Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark" 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.
--- ---

2
docs/navigation-structure.md
View File

@ -200,7 +200,7 @@ To add a auxiliary navigation item to your site (in the upper right on all pages
#### Example #### Example
{: .no_toc } {: .no_toc }
```yml ```yaml
# Aux links for the upper right navigation # Aux links for the upper right navigation
aux_links: aux_links:
"Just the Docs on GitHub": "Just the Docs on GitHub":

6
docs/search.md
View File

@ -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: 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 }}": { {% 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: In your site's `_config.yml`, enable search:
```yml ```yaml
# Enable or disable the site search # Enable or disable the site search
search_enabled: true search_enabled: true
``` ```

2
just-the-docs.gemspec
View File

@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
spec.authors = ["Patrick Marsceill"] spec.authors = ["Patrick Marsceill"]
spec.email = ["patrick.marsceill@gmail.com"] 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.homepage = "https://github.com/pmarsceill/just-the-docs"
spec.license = "MIT" spec.license = "MIT"