mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-16 14:23:31 -06:00
Compare commits
44 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
14a3ff5fc8 | ||
|
|
529c789739 | ||
|
|
721484a26e | ||
|
|
3d01578c7d | ||
|
|
9663d4cba3 | ||
|
552bf46bc9 | ||
|
|
6c5d550fa5 | ||
|
|
0f2de675b6 | ||
|
|
38521bd845 | ||
|
|
a4da666d2a | ||
|
|
f1dcbec0a9 | ||
|
|
e6f6001960 | ||
|
|
501bd0169c | ||
|
|
f06cf593ff | ||
|
|
460e9ae236 | ||
|
|
4d3375a834 | ||
|
|
3a3c4a83fa | ||
|
|
0254d9961a | ||
|
d2b3d57eb9 | ||
|
|
32401d05a3 | ||
|
|
9a076b48ac | ||
|
|
2c789d408c | ||
|
|
4fb036ebac | ||
|
|
f255c07c7f | ||
|
|
ce2d213dbe | ||
|
|
95b76010c2 | ||
|
|
ca0af1795a | ||
|
|
f9e03e1248 | ||
|
|
c83bdf853e | ||
|
|
af77e527d0 | ||
|
|
151691eb09 | ||
|
|
4de1bdaf65 | ||
|
afaa3ab225 | ||
|
|
e356659dbe | ||
|
|
0ec44bd474 | ||
|
839cf91428 | ||
|
5291de45c5 | ||
|
92fb6d1908 | ||
|
|
8597aa4cac | ||
|
|
0bfd125087 | ||
|
|
25b6455ed7 | ||
|
|
b44efbf1da | ||
|
|
8aa5982cd5 | ||
|
|
20f21217ca |
35
.github/workflows/ci.yml
vendored
Normal file
35
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
on: [push]
|
||||||
|
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
|
||||||
|
jekyll:
|
||||||
|
name: Build Jekyll site
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- uses: actions/checkout@master
|
||||||
|
|
||||||
|
- name: Build the site in the jekyll/builder container
|
||||||
|
run: |
|
||||||
|
docker run --rm \
|
||||||
|
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||||
|
jekyll/builder:3.8.5 /bin/bash -c "chmod 777 /srv/jekyll && jekyll build"
|
||||||
|
|
||||||
|
css:
|
||||||
|
name: Stylelint
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- uses: actions/checkout@master
|
||||||
|
|
||||||
|
- name: Use Node.js 10.x
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
version: 10.x
|
||||||
|
|
||||||
|
- name: npm install, build, and test
|
||||||
|
run: |
|
||||||
|
npm install
|
||||||
|
npm test
|
||||||
39
.github/workflows/publish.yml
vendored
Normal file
39
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: Publish Gem
|
||||||
|
|
||||||
|
on: [release]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build + Publish
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@master
|
||||||
|
- name: Set up Ruby 2.6
|
||||||
|
uses: actions/setup-ruby@v1
|
||||||
|
with:
|
||||||
|
version: 2.6.x
|
||||||
|
|
||||||
|
- name: Publish to GPR
|
||||||
|
run: |
|
||||||
|
mkdir -p $HOME/.gem
|
||||||
|
touch $HOME/.gem/credentials
|
||||||
|
chmod 0600 $HOME/.gem/credentials
|
||||||
|
printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||||
|
gem build just-the-docs.gemspec
|
||||||
|
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
|
||||||
|
env:
|
||||||
|
GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
|
||||||
|
OWNER: pmarsceill
|
||||||
|
|
||||||
|
- name: Publish to RubyGems
|
||||||
|
run: |
|
||||||
|
mkdir -p $HOME/.gem
|
||||||
|
touch $HOME/.gem/credentials
|
||||||
|
chmod 0600 $HOME/.gem/credentials
|
||||||
|
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||||
|
gem build just-the-docs.gemspec
|
||||||
|
gem push *.gem
|
||||||
|
env:
|
||||||
|
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
|
||||||
|
|
||||||
14
.travis.yml
14
.travis.yml
@@ -1,14 +0,0 @@
|
|||||||
language: ruby
|
|
||||||
rvm:
|
|
||||||
- 2.3.0
|
|
||||||
env:
|
|
||||||
- TRAVIS_NODE_VERSION="9.3.0"
|
|
||||||
|
|
||||||
install:
|
|
||||||
- npm install
|
|
||||||
- gem install bundler --version '>=1.17.1'
|
|
||||||
- bundle install
|
|
||||||
|
|
||||||
script:
|
|
||||||
- npm run test
|
|
||||||
- bundle exec jekyll build
|
|
||||||
@@ -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
|
||||||
@@ -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 site.plugins.jekyll-seo == nil %}
|
||||||
|
<title>{{ page.title }} - {{ site.title }}</title>
|
||||||
|
|
||||||
{% if page.description %}
|
{% if page.description %}
|
||||||
<meta name="Description" content="{{ page.description }}">
|
<meta name="Description" content="{{ page.description }}">
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<link rel="shortcut icon" href="{{ "favicon.ico" | absolute_url }}" type="image/x-icon">
|
||||||
|
|
||||||
<title>{{ page.title }} - {{ site.title }}</title>
|
|
||||||
<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>
|
||||||
|
|||||||
@@ -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>
|
||||||
|
|
||||||
|
|||||||
@@ -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;
|
||||||
|
|||||||
@@ -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 {
|
||||||
|
|||||||
@@ -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,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;
|
||||||
|
|||||||
@@ -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,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;
|
||||||
|
|||||||
@@ -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";
|
|
||||||
|
|||||||
@@ -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
BIN
favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
2
index.md
2
index.md
@@ -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 %})
|
||||||
|
|||||||
@@ -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"
|
||||||
|
|||||||
2890
package-lock.json
generated
2890
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
11
package.json
11
package.json
@@ -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'"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user