mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-16 06:13:32 -06:00
Compare commits
51 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
f255c07c7f | ||
|
ce2d213dbe | ||
|
|
95b76010c2 | ||
|
|
ca0af1795a | ||
|
|
f9e03e1248 | ||
|
|
c83bdf853e | ||
|
|
af77e527d0 | ||
|
|
151691eb09 | ||
|
|
4de1bdaf65 | ||
|
afaa3ab225 | ||
|
e356659dbe | ||
|
|
0ec44bd474 | ||
|
839cf91428 | ||
|
5291de45c5 | ||
|
92fb6d1908 | ||
|
|
8597aa4cac | ||
|
|
0bfd125087 | ||
|
|
25b6455ed7 | ||
|
|
b44efbf1da | ||
|
|
8aa5982cd5 | ||
|
|
20f21217ca | ||
|
|
96c053bb63 | ||
|
|
d9a5bd0a19 | ||
|
|
0ac8ec23bf | ||
|
|
c40eec1c2f | ||
|
|
de98c2b51b | ||
|
|
c70f012eee | ||
|
|
aee6d1fb8c | ||
|
|
f5d6cf6222 | ||
|
|
f3fc9d9dd3 | ||
|
|
a8c282ae5a | ||
|
|
e12408d07b | ||
|
|
a44d3a8652 | ||
|
|
ad867e37c0 | ||
|
|
01b500b1b3 | ||
|
|
84f8f003ac | ||
|
|
ab20833d17 | ||
|
|
b77d22cf2e | ||
|
|
35d7864874 | ||
|
|
c9e4284754 | ||
|
da0762007d | ||
|
5b8ff78bb6 | ||
|
04e81c7158 | ||
|
|
b7913ec5a5 | ||
|
|
25250db5e0 | ||
|
|
75f0ef57e2 | ||
|
|
eaafeee675 | ||
|
|
10c0f95b40 | ||
|
|
8da9b82d66 | ||
|
|
b0e1c64a5a | ||
|
d7b1adb8c7 |
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
16
.github/main.workflow
vendored
Normal file
16
.github/main.workflow
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
workflow "Publish to RubyGems" {
|
||||
on = "release"
|
||||
resolves = ["scarhand/actions-ruby@master"]
|
||||
}
|
||||
|
||||
action "Build from Gemspec" {
|
||||
uses = "scarhand/actions-ruby@master"
|
||||
runs = "build just-the-docs.gemspec"
|
||||
}
|
||||
|
||||
action "scarhand/actions-ruby@master" {
|
||||
uses = "scarhand/actions-ruby@master"
|
||||
needs = ["Build from Gemspec"]
|
||||
runs = "push *.gem"
|
||||
secrets = ["RUBYGEMS_AUTH_TOKEN"]
|
||||
}
|
||||
@@ -16,7 +16,7 @@
|
||||
title: Just the Docs
|
||||
description: A Jekyll theme for documentation
|
||||
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
|
||||
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
|
||||
permalink: pretty
|
||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
|
||||
@@ -31,3 +31,10 @@ aux_links:
|
||||
|
||||
# Color scheme currently only supports "dark" or nil (default)
|
||||
color_scheme: nil
|
||||
|
||||
# Google Analytics Tracking (optional)
|
||||
# e.g, UA-1234567-89
|
||||
ga_tracking: UA-2709176-10
|
||||
|
||||
plugins:
|
||||
- jekyll-seo-tag
|
||||
@@ -7,10 +7,22 @@
|
||||
|
||||
<title>{{ page.title }} - {{ site.title }}</title>
|
||||
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
|
||||
|
||||
{% if site.ga_tracking != nil %}
|
||||
<script>
|
||||
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
||||
ga('create', '{{ site.ga_tracking }}', '{{ site.url }}');
|
||||
ga('send', 'pageview');
|
||||
</script>
|
||||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||||
{% endif %}
|
||||
|
||||
{% if site.search_enabled != nil %}
|
||||
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
|
||||
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
|
||||
{% endif %}
|
||||
<script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
{% seo %}
|
||||
</head>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en-us">
|
||||
<html lang="{{ site.lang | default: "en-US" }}">
|
||||
{% include head.html %}
|
||||
<body>
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
|
||||
</footer>
|
||||
</div>
|
||||
<div class="main-content-wrap">
|
||||
<div class="main-content-wrap js-main-content" tabindex="0">
|
||||
<div class="page-header">
|
||||
<div class="main-content">
|
||||
{% if site.search_enabled != nil %}
|
||||
@@ -36,7 +36,7 @@
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
<div class="main-content js-main-content" tabindex="0">
|
||||
<div class="main-content">
|
||||
{% unless page.url == "/" %}
|
||||
{% if page.parent %}
|
||||
<nav class="breadcrumb-nav">
|
||||
|
||||
@@ -21,13 +21,13 @@
|
||||
list-style-type: none;
|
||||
counter-reset: step-counter;
|
||||
|
||||
li {
|
||||
> li {
|
||||
position: relative;
|
||||
|
||||
&::before {
|
||||
position: absolute;
|
||||
top: 0.2em;
|
||||
left: -1.5em;
|
||||
left: -1.6em;
|
||||
color: $grey-dk-000;
|
||||
content: counter(step-counter);
|
||||
counter-increment: step-counter;
|
||||
@@ -54,10 +54,10 @@
|
||||
ul {
|
||||
list-style: none;
|
||||
|
||||
li {
|
||||
> li {
|
||||
&::before {
|
||||
position: absolute;
|
||||
margin-left: -1.5em;
|
||||
margin-left: -1.4em;
|
||||
color: $grey-dk-000;
|
||||
content: "•";
|
||||
}
|
||||
|
||||
@@ -120,7 +120,8 @@
|
||||
}
|
||||
}
|
||||
|
||||
// stylelint-disable selector-no-type
|
||||
// stylelint-disable selector-max-type
|
||||
|
||||
body {
|
||||
position: relative;
|
||||
padding-bottom: $sp-10;
|
||||
@@ -130,7 +131,8 @@ body {
|
||||
padding-bottom: 0;
|
||||
}
|
||||
}
|
||||
// stylelint-enable selector-no-type
|
||||
|
||||
// stylelint-enable selector-max-type
|
||||
|
||||
.site-footer {
|
||||
position: absolute;
|
||||
|
||||
@@ -16,6 +16,12 @@
|
||||
// Support
|
||||
@import "./support/support";
|
||||
|
||||
//
|
||||
// Import custom overrides
|
||||
//
|
||||
|
||||
@import "./custom/custom";
|
||||
|
||||
//
|
||||
// Import custom color scheme scss
|
||||
//
|
||||
@@ -36,8 +42,3 @@
|
||||
@import "./tables";
|
||||
@import "./code";
|
||||
@import "./utilities/utilities";
|
||||
|
||||
//
|
||||
// Import custom overrides
|
||||
//
|
||||
@import "./custom/custom";
|
||||
|
||||
@@ -54,7 +54,7 @@ function initSearch() {
|
||||
|
||||
jsPath = source.replace('just-the-docs.js', '');
|
||||
|
||||
jsonPath = jsPath + '/search-data.json';
|
||||
jsonPath = jsPath + 'search-data.json';
|
||||
|
||||
var request = new XMLHttpRequest();
|
||||
request.open('GET', jsonPath, true);
|
||||
@@ -108,7 +108,7 @@ function initSearch() {
|
||||
} else {
|
||||
var results = index.search(query);
|
||||
|
||||
if (results.length > 1) {
|
||||
if (results.length > 0) {
|
||||
searchResults.classList.add('active');
|
||||
var resultsList = document.createElement('ul');
|
||||
searchResults.appendChild(resultsList);
|
||||
@@ -153,7 +153,6 @@ function initSearch() {
|
||||
function pageFocus() {
|
||||
var mainContent = document.querySelector('.js-main-content');
|
||||
mainContent.focus();
|
||||
console.log(mainContent)
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -5,8 +5,22 @@ nav_order: 2
|
||||
---
|
||||
|
||||
# Configuration
|
||||
{: .no_toc }
|
||||
|
||||
Just the Docs has some specific configuration parameters that can be defined 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.
|
||||
{: .fs-6 .fw-300 }
|
||||
|
||||
## Table of contents
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
|
||||
---
|
||||
|
||||
|
||||
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
|
||||
|
||||
## Search enabled
|
||||
|
||||
@@ -48,3 +62,11 @@ addEvent(toggleDarkMode, 'click', function(){
|
||||
</script>
|
||||
|
||||
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
|
||||
|
||||
## Google Analytics
|
||||
|
||||
```yaml
|
||||
# Google Analytics Tracking (optional)
|
||||
# e.g, UA-1234567-89
|
||||
ga_tracking: UA-5555555-55
|
||||
```
|
||||
|
||||
@@ -94,6 +94,24 @@ end
|
||||
- level 2 item
|
||||
- level 1 item
|
||||
|
||||
### Nesting an ol in ul in an ol
|
||||
|
||||
- level 1 item (ul)
|
||||
1. level 2 item (ol)
|
||||
1. level 2 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
- level 1 item (ul)
|
||||
1. level 2 item (ol)
|
||||
1. level 2 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
1. level 4 item (ol)
|
||||
1. level 4 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
- level 1 item (ul)
|
||||
|
||||
### And a task list
|
||||
|
||||
- [ ] Hello, this is a TODO item
|
||||
|
||||
@@ -105,8 +105,8 @@ This button will be hidden until medium screen sizes:
|
||||
These headings will be `inline-block`:
|
||||
|
||||
### heading 3
|
||||
{ .d-inline-block }
|
||||
{: .d-inline-block }
|
||||
|
||||
### heading 3
|
||||
{ .d-inline-block }
|
||||
{: .d-inline-block }
|
||||
```
|
||||
|
||||
4
index.md
4
index.md
@@ -58,6 +58,8 @@ $ bundle exec jekyll serve
|
||||
```
|
||||
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
||||
|
||||
If you're hosting your site on GitHub Pages, [set up GitHub Pages and Jekyll locally](https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll) so that you can more easily work in your development environment.
|
||||
|
||||
### Configure Just the Docs
|
||||
|
||||
- [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %})
|
||||
@@ -66,7 +68,7 @@ $ bundle exec jekyll serve
|
||||
|
||||
## About the project
|
||||
|
||||
Just the Docs is © 2017 by [Patrick Marsceill](http://patrickmarsceill.com).
|
||||
Just the Docs is © 2017-2019 by [Patrick Marsceill](http://patrickmarsceill.com).
|
||||
|
||||
### License
|
||||
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "just-the-docs"
|
||||
spec.version = "0.2.1"
|
||||
spec.version = "0.2.4"
|
||||
spec.authors = ["Patrick Marsceill"]
|
||||
spec.email = ["patrick.marsceill@gmail.com"]
|
||||
|
||||
spec.summary = %q{A nice looking, highly customizable, responsive Jekyll theme for documentation with built-in search.}
|
||||
spec.summary = %q{A modern, high customizable, responsive Jekyll theme for documention with built-in search.}
|
||||
spec.homepage = "https://github.com/pmarsceill/just-the-docs"
|
||||
spec.license = "MIT"
|
||||
|
||||
@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
|
||||
spec.executables << 'just-the-docs'
|
||||
|
||||
spec.add_runtime_dependency "jekyll", "~> 3.8.5"
|
||||
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.0"
|
||||
spec.add_runtime_dependency "rake", "~> 12.3.1"
|
||||
|
||||
spec.add_development_dependency "bundler", "~> 2.0.1"
|
||||
|
||||
@@ -14,7 +14,7 @@ namespace :search do
|
||||
{
|
||||
{% for page in site.html_pages %}{% if page.search_exclude != true %}"{{ forloop.index0 }}": {
|
||||
"id": "{{ forloop.index0 }}",
|
||||
"title": "{{ page.title | replace: '&', '&' }}",
|
||||
"title": "{{ page.title | replace: \'&\', \'&\' }}",
|
||||
"content": "'+content+'",
|
||||
"url": "{{ page.url | absolute_url }}",
|
||||
"relUrl": "{{ page.url }}"
|
||||
|
||||
2968
package-lock.json
generated
2968
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
13
package.json
13
package.json
@@ -1,15 +1,18 @@
|
||||
{
|
||||
"name": "just-the-docs",
|
||||
"version": "0.2.1",
|
||||
"description": "A Jekyll theme for documentation",
|
||||
"version": "0.2.4",
|
||||
"description": "A modern Jekyll theme for documentation",
|
||||
"repository": "pmarsceill/just-the-docs",
|
||||
"license": "MIT",
|
||||
"bugs": "https://github.com/pmarsceill/just-the-docs/issues",
|
||||
"devDependencies": {
|
||||
"stylelint": "^9.9.0",
|
||||
"stylelint-config-primer": "^3.0.1"
|
||||
"stylelint": "^10.0.1",
|
||||
"stylelint-config-primer": "^6.0.0",
|
||||
"stylelint-selector-no-utility": "^4.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@primer/css": "^12.2.3"
|
||||
},
|
||||
"dependencies": {},
|
||||
"scripts": {
|
||||
"test": "stylelint '**/*.scss'"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user