aksakalli/jekyll-doc-theme

Jekyll theme for creating project documentation websites

jekyll-doc-theme's Issues

Static resources links invalid if site run in docker

Problem:
nginx is compaining that it can not find the static js resources while run under other contextpath

My solution:

1: Create a Dockerfile

FROM nginx:alpine
COPY _site /usr/share/nginx/html
EXPOSE 80

2: create a build.sh file

#!/usr/bin/env bash
set -e # halt script on error
#building dev
bundle exec jekyll build --config _config.yml,_config_dev.yml

docker build -t nginx-build-docspages . && docker run --rm -p 80:80 --name build-docspages nginx-build-docspages

3: create a _config_dev.yml file:

# Site settings
baseurl: "" # <-- perhaps alternate solution is to set this as the same as on github?

# theme options from https://bootswatch.com/
# comment out this to use default Bootstrap
bootwatch: journal

# Build settings
markdown: kramdown
highlighter: rouge
plugins:
  - jekyll-feed
  - jekyll-redirect-from
  - jekyll-seo-tag
  - jekyll-sitemap

exclude:
  - Gemfile
  - Gemfile.lock
  - .idea/
  - .gitignore
  - README.md
  - Dockerfile
  - build.sh

4: Some changes to _includes/js_files.html are required:

<script>
  var baseurl = '{{ site.baseurl }}'
</script>
<script src="{{ '/js/jquery-1.10.2.min.js' | prepend: site.baseurl }}"></script>
<script src="{{ '/js/bootstrap.min.js' | prepend: site.baseurl }}"></script>
<script src="{{ '/js/typeahead.bundle.min.js' | prepend: site.baseurl }}"></script>
<script src="{{ '/js/main.js' | prepend: site.baseurl }}"></script>

The file jquery-1.10.2.min.js must be added to the js folder.

5: run the build.sh script and navigate to http://localhost

Change default font size

I'd like to change two minimal default settings to this otherwise excellent theme (the best I've encoutered so far!). I find that the the layout of a doc page is quite dense, and I find the font-size too small (here for example I used H4 titles in order not to have huge differences between titles and main text). Is there a relatively simple way to change two settings:

• default text fontsize
• space between text blocks or between titles and text blocks or between images and text blocks in order to make a less-dense imporession on the reader

I'm not very familiar with html or css, therefore my simple question (apologies!)

broken link

This link in your front page is broken: https://github.com/aksakalli/jekyll-doc-theme/master

Missing `<li>` tag in `docs_nav.html`

There is a missing <li> tag in the {% for item in section.docs %} loop in docs_nav.html file.

I've fixed it in my fork and can do a pull request if desired.

Issue with Search Field

There seems to be an issue when I type in the Search Field. The drop-down results do not display correctly and are barely clickable, and the issue is different in each browser/platform. Let me know if you need more info, I will see what else I can find.

Asset folders not copied when using remote-theme

Whether it's the Jekyll or gh-pages version the current assets folders are not being copied when attempting to use remote-theme: aksakalli/jekyll-doc-theme@gh-pages. I like the theme, but I don't want to clone the entire thing into my project to use it.

With some minor changes I was able to get it working with

remote-theme: kenjdavidson/jekyll-doc-theme@gh-pages

and I'm curious if you'd be interested in those? Or if it's something that you've looked into doing?

footnote linebreak bug

Using sup causes a line break. Footnote links also break the line.

Docker instalation fail

[builder 6/8] RUN bundle install:
#0 0.762 Bundler 2.4.7 is running, but your lockfile was generated with 2.2.31. Installing Bundler 2.2.31 and restarting using that version.
#0 2.170 Fetching gem metadata from https://rubygems.org/.
#0 2.233 Fetching bundler 2.2.31
#0 2.560 Installing bundler 2.2.31
#0 2.917 Calling DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. Please call DidYouMean.correct_error(error_name, spell_checker)' instead.
#0 4.216 Fetching gem metadata from https://rubygems.org/.........
#0 9.698 Resolving dependencies...
#0 9.960 nokogiri-1.13.6-x86_64-linux requires ruby version < 3.2.dev, >= 2.6, which is
#0 9.960 incompatible with the current version, ruby 3.2.1p31

---

Dockerfile:12

10 | WORKDIR /jekyll
11 | ADD Gemfile Gemfile.lock ./
12 | >>> RUN bundle install
13 |
14 | ADD . .

ERROR: failed to solve: process "/bin/sh -c bundle install" did not complete successfully: exit code: 5

header tag oddities

Hi. I liked your theme and have been tinkering with a derivative of it on and off. I've painted myself into a bit of corner though and it relates to this block:

*[id]:before {
    display: block;
    content: " ";
    margin-top: -75px;
    height: 75px;
    visibility: hidden;
}

Leaving it in causes some weird background-color highlighting of h2/h3/h4 that I have -- in the same way that a developers tool extension will highlight a large block around a simple h2 in your docs/ sample. For example, changing an h2 element on your pages site in dev tools:

Taking it out causes skipping to an anchor/id in the URL bar to overshoot, so it has scrolled off the top. Presumably this is related to the navbar? But to be honest I couldn't really grok the original purpose or find any correlation. Thanks again for the theme!

Any hints appreciated!

Collections in Subdirectories

Hey, love this theme. Great for grouping relative content into separate exploratory topics!

I'm trying to get docs_nav.html and section-nav.html to function for subdirectories as individual collections; in other words, only pages within said subdirectory will populate in the side nav. For example:

animal-species/
├── _docs/
│   ├── _mammals/
│   │  ├── page01.md
│   │  └── page02.md
│   ├── _reptiles/
│   │  ├── page01.md
│   │  └── page02.md

I'm newer to Liquid and collections, so this is most-likely a basic question, but I'm stumped and Google isn't helping. I'm trying to keep the directory structure as tight as possible, with as much nesting that's feasible. I originally set the nav files for each individual subfolder and module using appending and prepending, which worked, but was a logistical nightmare. I there a way to get the site to populate collections separately as per subdirectory? I've tried adding to _config:

collections_dir: docs
collections:
  mammals:
    permalink: /:collection/:path/
    output: true
  reptiles:
    output: true
    permalink: /:collection/:path/

running Jekyll 3.7.0, but I lose the page entirely (404). Adding includes: ['_mammals'] helps to an extent, but it only returns HTML.

Is there an easy command or fix for this? With 100+ site pages, I only want the nav to paginate high-level related content from master pages, such as "Mammals". I really appreciate your ideas on this! Thank you!

Update to Bootstrap 4

It'd be a bit of work, but it'd be great to update this theme to use Bootstrap 4.

Can not serve

Following the instructions in the readme I still get the following errors

➔ jekyll serve
WARN: Unresolved specs during Gem::Specification.reset:
      rb-fsevent (>= 0.9.4, ~> 0.9)
      rb-inotify (>= 0.9.7, ~> 0.9)
WARN: Clearing out unresolved specs.
Please report a bug if this causes problems.
/usr/local/lib/ruby/gems/2.3.0/gems/bundler-1.15.1/lib/bundler/runtime.rb:317:in `check_for_activated_spec!': You have alreadyactivated sass 3.4.24, but your Gemfile requires sass 3.4.23. Prepending `bundle exec` to your command may solve this. (Gem::LoadError)
        from /usr/local/lib/ruby/gems/2.3.0/gems/bundler-1.15.1/lib/bundler/runtime.rb:32:in `block in setup'
        from /usr/local/lib/ruby/gems/2.3.0/gems/bundler-1.15.1/lib/bundler/runtime.rb:27:in `map'
        from /usr/local/lib/ruby/gems/2.3.0/gems/bundler-1.15.1/lib/bundler/runtime.rb:27:in `setup'
        from /usr/local/lib/ruby/gems/2.3.0/gems/bundler-1.15.1/lib/bundler.rb:101:in `setup'
        from /usr/local/lib/ruby/gems/2.3.0/gems/jekyll-3.5.0/lib/jekyll/plugin_manager.rb:48:in `require_from_bundler'
        from /usr/local/lib/ruby/gems/2.3.0/gems/jekyll-3.5.0/exe/jekyll:9:in `<top (required)>'
        from /usr/local/bin/jekyll:23:in `load'
        from /usr/local/bin/jekyll:23:in `<main>'

I don't think it is a good idea to start editing all the versions (I did it for fun, but...)

Any idea what is going on?

maybe add ".html" to /allposts

I use nginx to run this website. I got a 404 error after setting it up and trying to access all blog posts through the link "All posts ..." in the blog, because it links to "https://your-domain.com/allposts" instead of "https://your-domain.com/allposts.html".

To solve this, you either have to add .html to /allposts in _layouts/post.html line 15

Or make nginx rewrite the url, which seems more complicated.

Thanks for providing this theme. I really like it 😃

Licensing

Firstly, thanks for making this nice theme available.

We'd like to use it and are wondering about licensing. The main "LICENSE" file is an MIT license, which is great. However, there is a lot of other content which looks as if it is imported from other sources. So, other licenses may apply.

• I've already seen that FontAwesome 4.7.0 is being used.
• There are also .scss files in _sass that look copied in (inferring this based on the fact that they all appear entirely in one commit), some of which is from bootswatch, but for others its unclear. Could you clarify where this comes from, please?

Latex support?

Thanks for this great theme!

Is there a way to enable latex support in markdown? I've tried to use latex syntax without success, but I know it works well on other jekyll websites I'm maintaining.

Search on local system

I installed jekyll-doc-theme on my local jekyll system. Generally it works fine instead of the search. I got no error message or something like that.

Are there any dependencies for the search?

Customize CSS

Had trouble while customizing CSS.

As the post (https://help.github.com/articles/customizing-css-and-html-in-your-jekyll-theme/) from Github Pages official explains how to, I followed it. But /assets/css/style.scss does not work.

And I also tried to understand how default CSS codes are generated from bootstrap, bootswatch. There are many parts that seems to be related to generate CSS, especially at directory _sass/~~/_variable.scss. So I didn't have any idea where to insert inner structured SCSS code in those.

Can you guys give me the solution to simply customize my Github Pages? :)

Your theme has been updated to Jekyll Themes

Your theme has been updated to https://jekyll-thmes.com.

When i fork this theme i can't search with google

I forked this theme and i need to implement google search box, but when apply i can't receive anything results.

On google i type:

welcome site:https://arte-peru.github.io/arte-peru/ ---> Don't work =(

but i type:

welcome site:https://aksakalli.github.io/jekyll-doc-theme// ---> Work

Serve jekyll-doc-theme/docs/ in root (/)

How would I do if I wanted to serve "jekyll-doc-theme/docs/" directly as root. I'm very new to jekyll and my google skillz didn't find anything.

Where is main.css

My browser want to find a file names main.css but in the assets folder, there's no such file. I just find main.scss but...
I cannot use this theme normally. Help me please. If you want check it by yourself please go to: quickstage.org

simple local example, doesn't work

I am unable to get this working. Error at end. Here are the steps I took:

1. cloned this repo
2. edited Gemfile to use "Jekyll" instead of "GitHub pages"
3. also uncommented the Jekyll plugins group. Gemfile is shown below.
4. ran bundle install to get dependencies
5. Ran bundle exec Jekyll serve (or build) and got following errors.

Gemfile:

source "https://rubygems.org"
ruby RUBY_VERSION

 gem "jekyll", "4.0"
 

# to use GitHub Pages
#gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
 group :jekyll_plugins do
    gem "jekyll-feed"
    gem "jekyll-sitemap"
    gem "jekyll-redirect-from"
    gem "jekyll-seo-tag"
 end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
  gem "tzinfo", "~> 1.2"
  gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?

Errors:

sjs:[~/Development/github/jekyll-doc-theme] (gh-pages *): bundle exec jekyll serve
Calling `DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. Please call `DidYouMean.correct_error(error_name, spell_checker)' instead.
Configuration file: /Users/sjs/Development/github/jekyll-doc-theme/_config.yml
            Source: /Users/sjs/Development/github/jekyll-doc-theme
       Destination: /Users/sjs/Development/github/jekyll-doc-theme/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/_layouts/default.html: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/_layouts/docs.html: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/_layouts/page.html: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/_layouts/post.html: no implicit conversion of Hash into Integer 
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_posts/2017-02-01-welcome-to-jekyll.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_posts/2017-05-03-jekyll-doc-theme.md: no implicit conversion of Hash into Integer
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/assets/css/main.scss: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/assets/search.json: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/assets/404.html: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/assets/allposts.html: no implicit conversion of Hash into Integer 
Error reading file /Users/sjs/Development/github/jekyll-doc-theme/index.html: no implicit conversion of Hash into Integer 
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/customization.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/examples/bootstrap.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/examples/cheatsheet.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/examples/font-awesome.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/index.md: no implicit conversion of Hash into Integer
             Error: could not read file /Users/sjs/Development/github/jekyll-doc-theme/_docs/themes.md: no implicit conversion of Hash into Integer
       Jekyll Feed: Generating feed for posts
Could not generate source map SassC::NotRenderedError =>  
                    done in 0.156 seconds.
 Auto-regeneration: enabled for '/Users/sjs/Development/github/jekyll-doc-theme'
                    ------------------------------------------------
      Jekyll 4.0.0   Please append `--trace` to the `serve` command 
                     for any additional information or backtrace. 
                    ------------------------------------------------
/Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve/servlet.rb:3:in `require': cannot load such file -- webrick (LoadError)
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve/servlet.rb:3:in `<top (required)>'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve.rb:179:in `require_relative'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve.rb:179:in `setup'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve.rb:100:in `process'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/command.rb:89:in `block in process_with_graceful_fail'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/command.rb:89:in `each'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/command.rb:89:in `process_with_graceful_fail'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/lib/jekyll/commands/serve.rb:86:in `block (2 levels) in init_with_program'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `block in execute'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `each'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `execute'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/mercenary-0.3.6/lib/mercenary/program.rb:42:in `go'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/mercenary-0.3.6/lib/mercenary.rb:19:in `program'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/jekyll-4.0.0/exe/jekyll:15:in `<top (required)>'
	from /Users/sjs/.rbenv/versions/3.2.2/bin/jekyll:25:in `load'
	from /Users/sjs/.rbenv/versions/3.2.2/bin/jekyll:25:in `<top (required)>'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli/exec.rb:58:in `load'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli/exec.rb:58:in `kernel_load'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli/exec.rb:23:in `run'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli.rb:478:in `exec'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/vendor/thor/lib/thor/command.rb:27:in `run'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/vendor/thor/lib/thor.rb:392:in `dispatch'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli.rb:31:in `dispatch'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/vendor/thor/lib/thor/base.rb:485:in `start'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/cli.rb:25:in `start'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/exe/bundle:49:in `block in <top (required)>'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/lib/bundler/friendly_errors.rb:103:in `with_friendly_errors'
	from /Users/sjs/.rbenv/versions/3.2.2/lib/ruby/gems/3.2.0/gems/bundler-2.2.31/exe/bundle:37:in `<top (required)>'
	from /Users/sjs/.rbenv/versions/3.2.2/bin/bundle:25:in `load'
	from /Users/sjs/.rbenv/versions/3.2.2/bin/bundle:25:in `<main>'

Creating a new docs collection

What needs to be done if I want to have a new collection, available on the top navigation bar, that has the same functionality as Docs? Essentially, instead of having Docs | Blog on the top navigation bar, I want Docs | OtherDocs | Blog. Where OtherDocs has its own independent sidebar and such.

I feel that this is a really simple thing that I am just missing because I'm so new to jekyll site generation.

Thanks!

US-ASCII

Trying to use this theme in my own Gitlab-instance I get the following error

Liquid Exception: invalid byte sequence in US-ASCII in _layouts/redirect.html

I wonder where does this file come from?

Math Support?

How can we include math in our markdown files? My previous jekyll site used a simple {include math support.html}, but when I copy over the html file and use the command, math looks very wacky.

[search] Content Search feature

Is it possible to get a content search feature instead of searching page name ?

Sidebar not working

Hi there, I'm trying to create some documentation for a repository of mine. I currently have this in docs.yml:

- title: Cybersecurity
  docs:
    - title: Browsing The Internet Safely
      path: browsing
    - title: How To Keep Your Information Safe
      path: security

It doesn't show up in the sidebar when I test it. just an empty collapse menu.

Inside those two Markdown files is this:

browsing.md

---
title: Browsing The Internet Safely
permalink: /docs/cybersecurity/internet
---

security.md

---
title: How To Keep Your Information Safe
permalink: /docs/cybersecurity/privacy
---

If I go to those links in the browser, it shows up and works, but they don't show up in the sidebar.

What am I doing wrong, and how can I fix it?

Thanks!

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://aksakalli.github.io/jekyll-doc-theme/" and found these accessibility errors:

• Page https://aksakalli.github.io/jekyll-doc-theme/:
  • Issue 84132885-29c3-470a-9cf6-8732d794229c:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.H42.2
    • Message: Heading tag found with no content. Text that is not intended as a heading should not be marked up with heading tags.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(3) > h1
    • Context: <h1 class="text-center"><i class="fa fa-code-fork" aria...</h1>
  • Issue bd99b469-602a-439c-ab75-35f3c27986db:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(2) > p > a:nth-child(2)
    • Context: <a href="https://bootswatch.com/">Bootwatch themes</a>
  • Issue a3f5e8d6-94f8-4a05-a5a8-a26969e6a342:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(2) > p > a:nth-child(1)
    • Context: <a href="https://github.com/twbs/bootstrap-sass">bootstrap-sass</a>
  • Issue 8e199ff6-7dc5-4dfb-97a0-311afe368810:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.H42.2
    • Message: Heading tag found with no content. Text that is not intended as a heading should not be marked up with heading tags.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(2) > h1
    • Context: <h1 class="text-center"><i class="fa fa-cogs" aria-hidd...</h1>
  • Issue 589ab0fe-482d-434c-809c-9de22c09a330:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(1) > p > a
    • Context: <a href="https://pages.github.com">GitHub Pages</a>
  • Issue 976537bc-9aa8-4aef-9cb8-020058f2dbf6:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.H42.2
    • Message: Heading tag found with no content. Text that is not intended as a heading should not be marked up with heading tags.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(3) > div:nth-child(1) > h1
    • Context: <h1 class="text-center"><i class="fa fa-pencil" aria-hi...</h1>
  • Issue baaadf74-dd98-48f7-9e3f-2cbaac4b8825:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(1) > div:nth-child(1) > p > a:nth-child(3)
    • Context: <a href="https://pages.github.com">GitHub Pages</a>
  • Issue 1cc68c40-2780-4935-a26c-3a43a783d966:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(1) > div:nth-child(1) > p > a:nth-child(2)
    • Context: <a href="https://github.com/Shopify/liquid/wiki">Liquid</a>
  • Issue 83dfeee6-e12e-4d7d-9399-8f8e4206e9a2:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change text colour to #0378d5.
    • Selector: html > body > div > div > div:nth-child(2) > div:nth-child(1) > div:nth-child(1) > p > a:nth-child(1)
    • Context: <a href="https://daringfireball.net/projects/markdown/">Markdown</a>
  • Issue ebb5c75e-ab95-4d27-b488-36493bbd716f:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
    • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 3.12:1. Recommendation: change background to #0378d5.
    • Selector: html > body > div > div > div:nth-child(1) > div > p:nth-child(3) > a
    • Context: <a class="btn btn-primary btn-lg" href="/jekyll-doc-theme/docs/home/" role="button">Learn more</a>
  • Issue 404f07f9-6590-49c6-929b-66fb360e1530:
    • Type: Error
    • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.A.NoContent
    • Message: Anchor element found with a valid href attribute, but no link content has been supplied.
    • Selector: #navbar > div > ul > li > a
    • Context: <a href="https://github.com/aksakalli/jekyll-doc-theme"><i class="fa fa-github" aria-hi...</a>
  • Issue d9999adc-6e88-47ba-9fbd-60f036e1ae8c:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.F68
    • Message: This form field should be labelled in some way. Use the label element (either with a "for" attribute or wrapped around the form field), or "title", "aria-label" or "aria-labelledby" attributes as appropriate.
    • Selector: #search-box
    • Context: <input id="search-box" type="text" class="form-control tt-input" placeholder="Search..." autocomplete="off" spellcheck="false" dir="auto" style="position: relative; vertical-align: top; background-color: transparent;">
  • Issue d077ec03-3e8a-4853-a29e-04188a74429c:
    • Type: Error
    • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.InputText.Name
    • Message: This textinput element does not have a name available to an accessibility API. Valid names are: label element, title undefined, aria-label undefined, aria-labelledby undefined.
    • Selector: #search-box
    • Context: <input id="search-box" type="text" class="form-control tt-input" placeholder="Search..." autocomplete="off" spellcheck="false" dir="auto" style="position: relative; vertical-align: top; background-color: transparent;">
  • Issue 4a580b86-0a20-43c7-9d7b-e2a23a35f8db:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.F68
    • Message: This form field should be labelled in some way. Use the label element (either with a "for" attribute or wrapped around the form field), or "title", "aria-label" or "aria-labelledby" attributes as appropriate.
    • Selector: #navbar > div > form > div > span > input:nth-child(1)
    • Context: <input type="text" class="form-control tt-hint" readonly="" autocomplete="off" spellcheck="false" tabindex="-1" dir="ltr" style="position: absolute; top: 0px; left: 0px; border-color: transparent; box-shadow: none; opacity: 1; background: none 0% 0% ...
  • Issue 1ff41514-b44e-475b-a948-cf98c0e0a958:
    • Type: Error
    • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.InputText.Name
    • Message: This textinput element does not have a name available to an accessibility API. Valid names are: label element, title undefined, aria-label undefined, aria-labelledby undefined.
    • Selector: #navbar > div > form > div > span > input:nth-child(1)
    • Context: <input type="text" class="form-control tt-hint" readonly="" autocomplete="off" spellcheck="false" tabindex="-1" dir="ltr" style="position: absolute; top: 0px; left: 0px; border-color: transparent; box-shadow: none; opacity: 1; background: none 0% 0% ...
  • Issue d4599b2b-b2f2-4501-84b9-8ed2e6e6376a:
    • Type: Error
    • Code: WCAG2AA.Principle3.Guideline3_2.3_2_2.H32.2
    • Message: This form does not contain a submit button, which creates issues for those who cannot submit the form using the keyboard. Submit buttons are INPUT elements with type attribute "submit" or "image", or BUTTON elements with type "submit" or omitted/invalid.
    • Selector: #navbar > div > form
    • Context: <form class="navbar-form navbar-left"><div class...</form>

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.