steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-16 08:02:24 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into patch-1

Browse Source
This commit is contained in:
David Darnes 2019-06-17 17:43:05 +01:00 committed by GitHub
commit 761245d487
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 736 additions and 2249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.github/main.workflow vendored
View File

@ -1,16 +1,26 @@
workflow "Publish to RubyGems" { workflow "Publish to RubyGems" {
on = "release" on = "release"
resolves = ["scarhand/actions-ruby@master"] resolves = [
"Publish to GPR",
"Publish to Ruby Gems",
]
} }
action "Build from Gemspec" { action "Build from Gemspec" {
uses = "scarhand/actions-ruby@master" uses = "scarhand/actions-ruby@master"
runs = "build just-the-docs.gemspec" runs = "gem build just-the-docs.gemspec"
} }
action "scarhand/actions-ruby@master" { action "Publish to Ruby Gems" {
uses = "scarhand/actions-ruby@master" uses = "scarhand/actions-ruby@master"
needs = ["Build from Gemspec"] needs = ["Build from Gemspec"]
runs = "push *.gem" runs = "gem push *.gem"
secrets = ["RUBYGEMS_AUTH_TOKEN"] secrets = ["RUBYGEMS_AUTH_TOKEN"]
} }
action "Publish to GPR" {
uses = "scarhand/actions-ruby@master"
needs = ["Build from Gemspec"]
secrets = ["GPR_AUTH_TOKEN"]
runs = " gem push --key [\"GPR_AUTH_TOKEN\"] --host https://rubygems.pkg.github.com/pmarsceill *.gem"
}

3
_config.yml
View File

@ -35,3 +35,6 @@ color_scheme: nil
# Google Analytics Tracking (optional) # Google Analytics Tracking (optional)
# e.g, UA-1234567-89 # e.g, UA-1234567-89
ga_tracking: UA-2709176-10 ga_tracking: UA-2709176-10
plugins:
- jekyll-seo-tag

14
_includes/head.html
View File

@ -1,11 +1,17 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge"> <meta http-equiv="X-UA-Compatible" content="IE=Edge">
{% if page.description %}
<meta name="Description" content="{{ page.description }}"> {% if site.plugins.jekyll-seo == nil %}
<title>{{ page.title }} - {{ site.title }}</title>
{% if page.description %}
<meta name="Description" content="{{ page.description }}">
{% endif %}
{% endif %} {% endif %}
<title>{{ page.title }} - {{ site.title }}</title> <link rel="shortcut icon" href="{{ "favicon.ico" | absolute_url }}" type="image/x-icon">
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}"> <link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
{% if site.ga_tracking != nil %} {% if site.ga_tracking != nil %}
@ -23,4 +29,6 @@
<script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script> <script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
{% seo %}
</head> </head>

2
_layouts/default.html
View File

@ -1,6 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en-us"> <html lang="{{ site.lang | default: "en-US" }}">
{% include head.html %} {% include head.html %}
<body> <body>

6
_sass/layout.scss
View File

@ -120,7 +120,8 @@
} }
} }
// stylelint-disable selector-no-type // stylelint-disable selector-max-type
body { body {
position: relative; position: relative;
padding-bottom: $sp-10; padding-bottom: $sp-10;
@ -130,7 +131,8 @@ body {
padding-bottom: 0; padding-bottom: 0;
} }
} }
// stylelint-enable selector-no-type
// stylelint-enable selector-max-type
.site-footer { .site-footer {
position: absolute; position: absolute;

2
_sass/typography.scss
View File

@ -1,7 +1,7 @@
// //
// Typography // Typography
// //
// stylelint-disable primer/selector-no-utility, selector-no-type, selector-max-type // stylelint-disable primer/selector-no-utility, primer/no-override, selector-no-type, selector-max-type
h1, h1,
.text-alpha { .text-alpha {

2
_sass/utilities/_layout.scss
View File

@ -1,4 +1,4 @@
// stylelint-disable primer/selector-no-utility // stylelint-disable primer/selector-no-utility, primer/no-override
// //
// Utility classes for layout // Utility classes for layout
// //

2
_sass/utilities/_lists.scss
View File

@ -2,7 +2,7 @@
// Utility classes for lists // Utility classes for lists
// //
// stylelint-disable primer/selector-no-utility // stylelint-disable primer/selector-no-utility, primer/no-override
.list-style-none { .list-style-none {
padding: 0 !important; padding: 0 !important;

2
_sass/utilities/_spacing.scss
View File

@ -3,7 +3,7 @@
// //
// scss-lint:disable SpaceAfterPropertyName // scss-lint:disable SpaceAfterPropertyName
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility // stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility, primer/no-override
// Margin spacer utilities // Margin spacer utilities

2
_sass/utilities/_typography.scss
View File

@ -2,7 +2,7 @@
// Utility classes for typography // Utility classes for typography
// //
// stylelint-disable primer/selector-no-utility // stylelint-disable primer/selector-no-utility, primer/no-override
.fs-1 { .fs-1 {
@include fs-1; @include fs-1;

11
assets/css/just-the-docs.scss
View File

@ -16,6 +16,12 @@
// Support // Support
@import "./support/support"; @import "./support/support";
//
// Import custom overrides
//
@import "./custom/custom";
// //
// Import custom color scheme scss // Import custom color scheme scss
// //
@ -36,8 +42,3 @@
@import "./tables"; @import "./tables";
@import "./code"; @import "./code";
@import "./utilities/utilities"; @import "./utilities/utilities";
//
// Import custom overrides
//
@import "./custom/custom";

1
assets/js/just-the-docs.js
View File

@ -153,7 +153,6 @@ function initSearch() {
function pageFocus() { function pageFocus() {
var mainContent = document.querySelector('.js-main-content'); var mainContent = document.querySelector('.js-main-content');
mainContent.focus(); mainContent.focus();
console.log(mainContent)
} }

BIN
favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

2
index.md
View File

@ -58,6 +58,8 @@ $ bundle exec jekyll serve
``` ```
4. Point your web browser to [http://localhost:4000](http://localhost:4000) 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 ### Configure Just the Docs
- [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %}) - [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %})

3
just-the-docs.gemspec
View File

@ -2,7 +2,7 @@
Gem::Specification.new do |spec| Gem::Specification.new do |spec|
spec.name = "just-the-docs" spec.name = "just-the-docs"
spec.version = "0.2.3" spec.version = "0.2.5"
spec.authors = ["Patrick Marsceill"] spec.authors = ["Patrick Marsceill"]
spec.email = ["patrick.marsceill@gmail.com"] spec.email = ["patrick.marsceill@gmail.com"]
@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
spec.executables << 'just-the-docs' spec.executables << 'just-the-docs'
spec.add_runtime_dependency "jekyll", "~> 3.8.5" 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_runtime_dependency "rake", "~> 12.3.1"
spec.add_development_dependency "bundler", "~> 2.0.1" spec.add_development_dependency "bundler", "~> 2.0.1"

2904
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

11
package.json
View File

@ -1,15 +1,18 @@
{ {
"name": "just-the-docs", "name": "just-the-docs",
"version": "0.2.3", "version": "0.2.5",
"description": "A modern Jekyll theme for documentation", "description": "A modern Jekyll theme for documentation",
"repository": "pmarsceill/just-the-docs", "repository": "pmarsceill/just-the-docs",
"license": "MIT", "license": "MIT",
"bugs": "https://github.com/pmarsceill/just-the-docs/issues", "bugs": "https://github.com/pmarsceill/just-the-docs/issues",
"devDependencies": { "devDependencies": {
"stylelint": "^9.10.1", "stylelint": "^10.0.1",
"stylelint-config-primer": "^3.0.1" "stylelint-config-primer": "^7.0.0",
"stylelint-selector-no-utility": "^4.0.0"
},
"dependencies": {
"@primer/css": "^12.3.1"
}, },
"dependencies": {},
"scripts": { "scripts": {
"test": "stylelint '**/*.scss'" "test": "stylelint '**/*.scss'"
} }