diff --git a/404.html b/404.html new file mode 100644 index 0000000..56efce4 --- /dev/null +++ b/404.html @@ -0,0 +1,11 @@ +--- +layout: default +title: Page not found +permalink: /404 +nav_exclude: true +search_exclude: true +--- + +

Page not found

+ +

The page you requested could not be found. Try using the navigation {% if site.search_enabled %}or search {% endif %}to find what you're looking for or go to this site's home page.

diff --git a/README.md b/README.md index dff46d6..c78280a 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@

Just the Docs

-

A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub pages with few dependencies.

-

See it in action!

+

A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

+

See it in action!




- ![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif) ## Installation @@ -60,7 +59,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc To set up your environment to develop this theme, run `bundle install`. -Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. +Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released. diff --git a/_config.yml b/_config.yml index 9b02ede..ed1ee2a 100644 --- a/_config.yml +++ b/_config.yml @@ -19,7 +19,7 @@ baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog # url: "" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty -exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] +exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] # Enable or disable the site search search_enabled: true diff --git a/_includes/head.html b/_includes/head.html index cbd41f9..077564e 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,6 +1,9 @@ + {% if page.description %} + + {% endif %} {{ page.title }} - {{ site.title }} diff --git a/_includes/nav.html b/_includes/nav.html index 4ebd91f..2c4bf1e 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -1,4 +1,4 @@ -