diff --git a/docs/configuration.md b/docs/configuration.md index fcab4953165db84b68a1f6a0d7ca98c8dadfc083..64b23f1a2639919ad668fea24e47fe862b2006e2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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" ``` diff --git a/docs/customization.md b/docs/customization.md index 74c153c0bff7f96d491ca893a3bd223ab77333b9..f3fe1c036d6bb549638f369c48e911b152444c16 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -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. --- diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index 8a72e5ba0cf3ac0bcbd1ed707a5a373d9ac1bba8..98107cfcc3807de00ccbbcd73a8566019f8c8879 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -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": diff --git a/docs/search.md b/docs/search.md index 24afcd1bc047996757026fa3fe89db22528deed5..61822d5a073f795efd19f79c961ff6845faf1dea 100644 --- a/docs/search.md +++ b/docs/search.md @@ -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 ``` diff --git a/just-the-docs.gemspec b/just-the-docs.gemspec index 7a0260377a8f91d6bc5bd4fd56ae8235b4413b94..aba1bb57f3519fe09dd23803adcd016565fce2f0 100644 --- a/just-the-docs.gemspec +++ b/just-the-docs.gemspec @@ -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"