Skip to content

Commit ee100ee

Browse files
committed
update to modern slate
1 parent 2cc0cd7 commit ee100ee

37 files changed

+5975
-2857
lines changed

.editorconfig

Lines changed: 0 additions & 18 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Report a Bug
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Bug Description**
11+
A clear and concise description of what the bug is and how to reproduce it.
12+
13+
**Screenshots**
14+
If applicable, add screenshots to help explain your problem.
15+
16+
**Browser (please complete the following information):**
17+
- OS: [e.g. iOS]
18+
- Browser [e.g. chrome, safari]
19+
- Version [e.g. 22]
20+
21+
**Last upstream Slate commit (run `git log --author="\(Robert Lord\)\|\(Matthew Peveler\)\|\(Mike Ralphson\)" | head -n 1`):**
22+
Put the commit hash here

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions, Ideas, Discussions
4+
url: https://github.com/slatedocs/slate/discussions
5+
about: Ask and answer questions, and propose new features.

.github/ISSUE_TEMPLATE/start-here.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/dependabot.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: bundler
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10
8+
target-branch: dev
9+
versioning-strategy: increase-if-necessary

.github/workflows/build.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches: [ '*' ]
6+
pull_request:
7+
branches: [ '*' ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
ruby-version: [2.6, 2.7, '3.0', 3.1, 3.2]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
- name: Set up Ruby
20+
uses: ruby/setup-ruby@v1
21+
with:
22+
ruby-version: ${{ matrix.ruby-version }}
23+
24+
- uses: actions/cache@v3
25+
with:
26+
path: vendor/bundle
27+
key: gems-${{ runner.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }}
28+
restore-keys: |
29+
gems-${{ runner.os }}-${{ matrix.ruby-version }}-
30+
gems-${{ runner.os }}-
31+
32+
- run: bundle config set deployment 'true'
33+
- name: bundle install
34+
run: |
35+
bundle config path vendor/bundle
36+
bundle install --jobs 4 --retry 3
37+
38+
- run: bundle exec middleman build

.github/workflows/deploy.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches: [ 'main' ]
6+
7+
jobs:
8+
deploy:
9+
permissions:
10+
contents: write
11+
12+
runs-on: ubuntu-latest
13+
env:
14+
ruby-version: 2.6
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
- name: Set up Ruby
19+
uses: ruby/setup-ruby@v1
20+
with:
21+
ruby-version: ${{ env.ruby-version }}
22+
23+
- uses: actions/cache@v3
24+
with:
25+
path: vendor/bundle
26+
key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }}
27+
restore-keys: |
28+
gems-${{ runner.os }}-${{ env.ruby-version }}-
29+
gems-${{ runner.os }}-
30+
31+
- run: bundle config set deployment 'true'
32+
- name: bundle install
33+
run: |
34+
bundle config path vendor/bundle
35+
bundle install --jobs 4 --retry 3
36+
37+
- run: bundle exec middleman build
38+
39+
- name: Deploy
40+
uses: peaceiris/actions-gh-pages@v3
41+
with:
42+
github_token: ${{ secrets.GITHUB_TOKEN }}
43+
publish_dir: ./build
44+
keep_files: true

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ build/
1616
.cache
1717
.vagrant
1818
.sass-cache
19-
vendor/
2019

2120
# YARD artifacts
2221
.yardoc
2322
_yardoc
2423
doc/
2524
.idea/
2625

27-
source/.index.html.md.swp
28-
.gitignore.swp
26+
# Vagrant artifacts
27+
ubuntu-*-console.log

.travis.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 164 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,177 @@
11
# Changelog
22

3+
## Version 2.13.1
4+
5+
*January 31, 2023*
6+
7+
* Fix Vagrantfile gem install for ruby >= 2.6 (thanks @Cyb0rk)
8+
* Disable file watcher in run_build() for sake of qemu on arm64 (thanks @anapsix)
9+
* Expand deprecated git.io links to full url in docs (thanks @judge2020)
10+
* Add margin to paragraph following code-block on phones (thanks @tlhunter)
11+
* Bump nokogiri from 1.13.4 to 1.13.9
12+
* Bump rouge from 3.28.0 to 3.30.0
13+
* Bump redcarpet from 3.5.1 to 3.6.0
14+
* Bump middleman from 4.4.2 to 4.4.3
15+
* Bump middleman-syntax from 3.2.0 to 3.3.0
16+
* Bump webrick from 1.7.0 to 1.8.1
17+
18+
## Version 2.13.0
19+
20+
*April 22, 2022*
21+
22+
* __Drop support for ruby 2.5__
23+
* Bump rouge from 3.26.1 to 3.28.0
24+
* Formally support ruby 3.1
25+
* Bump nokogiri from 1.12.5 to 1.13.4
26+
* Build docker images for multiple architectures (e.g. `aarch64`)
27+
* Remove `VOLUME` declaration from Dockerfile (thanks @aemengo)
28+
29+
The security vulnerabilities reported against recent versions of nokogiri should not affect slate users with a regular setup.
30+
31+
## Version 2.12.0
32+
33+
*November 04, 2021*
34+
35+
* Bump nokogiri from 1.12.3 to 1.12.5
36+
* Bump ffi from 1.15.0 to 1.15.4
37+
* Bump rouge from 3.26.0 to 3.26.1
38+
* Bump middleman from 4.4.0 to 4.4.2
39+
* Remove unnecessary files from docker images
40+
41+
## Version 2.11.0
42+
43+
*August 12, 2021*
44+
45+
* __[Security]__ Bump addressable transitive dependency from 2.7.0 to 2.8.0
46+
* Support specifying custom meta tags in YAML front-matter
47+
* Bump nokogiri from 1.11.3 to 1.12.3 (minimum supported version is 1.11.4)
48+
* Bump middleman-autoprefixer from 2.10.1 to 3.0.0
49+
* Bump jquery from 3.5.1 to 3.6.0
50+
* Bump middleman from [`d180ca3`](https://github.com/middleman/middleman/commit/d180ca337202873f2601310c74ba2b6b4cf063ec) to 4.4.0
51+
52+
## Version 2.10.0
53+
54+
*April 13, 2021*
55+
56+
* Add support for Ruby 3.0 (thanks @shaun-scale)
57+
* Add requirement for Git on installing dependencies
58+
* Bump nokogiri from 1.11.2 to 1.11.3
59+
* Bump middleman from 4.3.11 to [`d180ca3`](https://github.com/middleman/middleman/commit/d180ca337202873f2601310c74ba2b6b4cf063ec)
60+
61+
## Version 2.9.2
62+
63+
*March 30, 2021*
64+
65+
* __[Security]__ Bump kramdown from 2.3.0 to 2.3.1
66+
* Bump nokogiri from 1.11.1 to 1.11.2
67+
68+
## Version 2.9.1
69+
70+
*February 27, 2021*
71+
72+
* Fix Slate language tabs not working if localStorage is disabled
73+
74+
## Version 2.9.0
75+
76+
*January 19, 2021*
77+
78+
* __Drop support for Ruby 2.3 and 2.4__
79+
* __[Security]__ Bump nokogiri from 1.10.10 to 1.11.1
80+
* __[Security]__ Bump redcarpet from 3.5.0 to 3.5.1
81+
* Specify slate is not supported on Ruby 3.x
82+
* Bump rouge from 3.24.0 to 3.26.0
83+
84+
## Version 2.8.0
85+
86+
*October 27, 2020*
87+
88+
* Remove last trailing newline when using the copy code button
89+
* Rework docker image and make available at slatedocs/slate
90+
* Improve Dockerfile layout to improve caching (thanks @micvbang)
91+
* Bump rouge from 3.20 to 3.24
92+
* Bump nokogiri from 1.10.9 to 1.10.10
93+
* Bump middleman from 4.3.8 to 4.3.11
94+
* Bump lunr.js from 2.3.8 to 2.3.9
95+
96+
## Version 2.7.1
97+
98+
*August 13, 2020*
99+
100+
* __[security]__ Bumped middleman from 4.3.7 to 4.3.8
101+
102+
_Note_: Slate uses redcarpet, not kramdown, for rendering markdown to HTML, and so was unaffected by the security vulnerability in middleman.
103+
If you have changed slate to use kramdown, and with GFM, you may need to install the `kramdown-parser-gfm` gem.
104+
105+
## Version 2.7.0
106+
107+
*June 21, 2020*
108+
109+
* __[security]__ Bumped rack in Gemfile.lock from 2.2.2 to 2.2.3
110+
* Bumped bundled jQuery from 3.2.1 to 3.5.1
111+
* Bumped bundled lunr from 0.5.7 to 2.3.8
112+
* Bumped imagesloaded from 3.1.8 to 4.1.4
113+
* Bumped rouge from 3.17.0 to 3.20.0
114+
* Bumped redcarpet from 3.4.0 to 3.5.0
115+
* Fix color of highlighted code being unreadable when printing page
116+
* Add clipboard icon for "Copy to Clipboard" functionality to code boxes (see note below)
117+
* Fix handling of ToC selectors that contain punctutation (thanks @gruis)
118+
* Fix language bar truncating languages that overflow screen width
119+
* Strip HTML tags from ToC title before displaying it in title bar in JS (backup to stripping done in Ruby code) (thanks @atic)
120+
121+
To enable the new clipboard icon, you need to add `code_clipboard: true` to the frontmatter of source/index.html.md.
122+
See [this line](https://github.com/slatedocs/slate/blame/main/source/index.html.md#L19) for an example of usage.
123+
124+
## Version 2.6.1
125+
126+
*May 30, 2020*
127+
128+
* __[security]__ update child dependency activesupport in Gemfile.lock to 5.4.2.3
129+
* Update Middleman in Gemfile.lock to 4.3.7
130+
* Replace Travis-CI with GitHub actions for continuous integration
131+
* Replace Spectrum with GitHub discussions
132+
133+
## Version 2.6.0
134+
135+
*May 18, 2020*
136+
137+
__Note__: 2.5.0 was "pulled" due to a breaking bug discovered after release. It is recommended to skip it, and move straight to 2.6.0.
138+
139+
* Fix large whitespace gap in middle column for sections with codeblocks
140+
* Fix highlighted code elements having a different background than rest of code block
141+
* Change JSON keys to have a different font color than their values
142+
* Disable asset hashing for woff and woff2 elements due to middleman bug breaking woff2 asset hashing in general
143+
* Move Dockerfile to Debian from Alpine
144+
* Converted repo to a [GitHub template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)
145+
* Update sassc to 2.3.0 in Gemfile.lock
146+
147+
## Version 2.5.0
148+
149+
*May 8, 2020*
150+
151+
* __[security]__ update nokogiri to ~> 1.10.8
152+
* Update links in example docs to https://github.com/slatedocs/slate from https://github.com/lord/slate
153+
* Update LICENSE to include full Apache 2.0 text
154+
* Test slate against Ruby 2.5 and 2.6 on Travis-CI
155+
* Update Vagrantfile to use Ubuntu 18.04 (thanks @bradthurber)
156+
* Parse arguments and flags for deploy.sh on script start, instead of potentially after building source files
157+
* Install nodejs inside Vagrantfile (thanks @fernandoaguilar)
158+
* Add Dockerfile for running slate (thanks @redhatxl)
159+
* update middleman-syntax and rouge to ~>3.2
160+
* update middleman to 4.3.6
161+
3162
## Version 2.4.0
4163

5164
*October 19, 2019*
6165

7166
- Move repository from lord/slate to slatedocs/slate
8167
- Fix documentation to point at new repo link, thanks to [Arun](https://github.com/slash-arun), [Gustavo Gawryszewski](https://github.com/gawry), and [Daniel Korbit](https://github.com/danielkorbit)
9168
- Update `nokogiri` to 1.10.4
10-
- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack)
11-
- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack)
12-
- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jackmack](https://github.com/jakemack)
13-
- Add sass gem, thanks to [jackmack](https://github.com/jackmack)
169+
- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack)
170+
- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack)
171+
- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jakemack](https://github.com/jakemack)
172+
- Add sass gem, thanks to [jakemack](https://github.com/jakemack)
14173
- Activate `asset_cache` in middleman to improve cacheability of static files, thanks to [Sam Gilman](https://github.com/thenengah)
15-
- Update to using bundler 2 for `Gemfile.lock`, thanks to [jackmack](https://github.com/jakemack)
174+
- Update to using bundler 2 for `Gemfile.lock`, thanks to [jakemack](https://github.com/jakemack)
16175

17176
## Version 2.3.1
18177

0 commit comments

Comments
 (0)