steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-15 15:42:24 -06:00
Code Issues Packages Projects Releases Wiki Activity
998 Commits 8 Branches 50 Tags
Commit Graph

998 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Ivan Skodje
f6b22804bc
fix: typo in README on _config.yml (#891) 2022-07-23 22:02:20 -07:00
Matt Wang
2049ebc394
consolidate CI files, updates Ruby and Node versions (#820) 
This is a PR with three key changes:

1. Consolidate two identical CI files, `ci.yml` and `ci-master.yml` into one file
2. Consolidate two almost-identical jobs (`jekyll-build-*`) into one job with a strategy matrix
3. Update various dependencies/platforms
    * Node: `12.x` -> `16.x` (only in CI); `12.x` has been EOL for a while
    * Ruby: `2.6` -> `2.7`; `2.6` just reached EOL
    * `actions/checkout` -> `v2` -> `v3`
    * switches `jekyll/builder` to `jekyll/jekyll`, since we don't actually use any of the features in `jekyll/builder`

## on our CI philosophy

In working on this, I have a couple of questions:

1. We don't actually use our `Dockerfile` that we provide. Does this make sense? Should we be running CI with this instead?
2. Is there a specific reason that we're using `jekyll/jekyll`? Notably, this isn't an official package, but a community-driven one. Does it match what's used by GitHub Pages?
3. Do we have to use any docker image at all? For example, what if we just rely on the `setup-ruby` action?
    * one advantage of this is that it's much easier for us to test across multiple OS versions; we just need to have a strategy matrix for OS and do windows, macos, ubuntu, etc.
    * another advantage is that we can easily test different ruby versions in conjunction with different jekyll versions

Eventually, I would like to see us test across:

* different Jekyll versions
* different OSes
* different Ruby versions

but perhaps that might be too aggressive. Happy for any feedback on this PR or those questions!
 2022-07-22 20:50:12 -07:00
Matt Wang
ba472b9aef
changelog: minor spacing fix 2022-07-19 22:05:56 -07:00
Matt Wang
7422c87605
Create CHANGELOG.md 2022-07-19 22:03:49 -07:00
Matt Wang
2e23f7b7ed
Adds Netlify badge 
partially a commit to start generating Netlify previews on arbitrary branches!
 2022-07-13 18:08:53 -07:00
Peter Mosses
1ecc3d08e0
Show how to break an ol (#856) 
* Show how to break an ol

Close #750

The theme uses CSS counters for ordered lists.
So to continue the numbering of an ordered list after a break,
use `style="counter-reset:none"` instead of `start="42"`.
Add the example from #750 to `docs/index-test.md` to test.

* Show how to start from 42

Close #750

The theme uses CSS counters for ordered lists.
To start the numbering of an ordered list with 42,
use `{:style="counter-reset:step-counter 41"}` instead of `start="42"`.

Add the example from #750 to `docs/index-test.md` to test.
 2022-07-04 19:20:17 +00:00
dependabot[bot]
10388ed8b0
Bump prettier from 2.6.2 to 2.7.1 (#864) 
Bumps [prettier](https://github.com/prettier/prettier) from 2.6.2 to 2.7.1.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.6.2...2.7.1)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2022-06-22 16:06:38 -07:00
Matt Wang
a45b328c7a
adds 'This site is powered by Netlify.' (#797) 
This PR adds a small link back to Netlify in the footer (specifically, in the user-editable config); this is a necessary prerequisite for the [Netlify OSS Plan](https://www.netlify.com/legal/open-source-policy). 

See: https://github.com/orgs/just-the-docs/teams/maintainers/discussions/1/comments/18.
 2022-06-16 02:51:59 +00:00
dependabot[bot]
3a834d24ab
Bump prettier from 2.5.1 to 2.6.2 (#809) 
Bumps [prettier](https://github.com/prettier/prettier) from 2.5.1 to 2.6.2.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.5.1...2.6.2)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2022-04-18 09:50:23 -07:00
Matt Wang
6afa220a39
adds webrick to Gemfile (#799) 
This is one solution for #798, namely that `webrick` is needed as an explicit dependency for Ruby 3+.

Closes #798.
 2022-04-18 08:28:57 -07:00
Patrick Marsceill
e892a261fb
Merge pull request #790 from just-the-docs/update-coc 
updates Code of Conduct to Contributor Covenant v2.1
 2022-03-10 15:55:27 -05:00
Matt Wang
68b7c8a534
updates code of conduct to Contributor Covenant v2.1 
See - https://www.contributor-covenant.org/version/2/1/code_of_conduct/
 2022-03-09 11:20:36 -08:00
dependabot[bot]
a14f32ceed
Bump prettier from 2.1.2 to 2.5.1 (#787) 
Bumps [prettier](https://github.com/prettier/prettier) from 2.1.2 to 2.5.1.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.1.2...2.5.1)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2022-03-09 17:35:25 +00:00
Patrick Marsceill
b0ed390a9f
Merge pull request #783 from just-the-docs/flo-devcontainer 
Add VScode devcontainer
 2022-03-09 12:04:41 -05:00
max06
00d3b4fe5a Add github extension 2022-03-09 18:00:08 +01:00
max06
45120c8742 Add info about the devcontainer to the readme 2022-03-09 18:00:08 +01:00
max06
2136b55a52 Add standard jekyll devcontainer 2022-03-09 18:00:08 +01:00
Patrick Marsceill
25de2c03a3
Merge pull request #627 from just-the-docs/dependabot/add-v2-config-file 
Upgrade to GitHub-native Dependabot
 2022-03-09 11:56:07 -05:00
Patrick Marsceill
c589be462e
Merge branch 'main' into dependabot/add-v2-config-file 2022-03-09 11:51:46 -05:00
dependabot[bot]
351a0b7ff4
Bump ajv from 6.10.0 to 6.12.6 (#766) 
Bumps [ajv](https://github.com/ajv-validator/ajv) from 6.10.0 to 6.12.6.
- [Release notes](https://github.com/ajv-validator/ajv/releases)
- [Commits](https://github.com/ajv-validator/ajv/compare/v6.10.0...v6.12.6)

---
updated-dependencies:
- dependency-name: ajv
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2022-03-08 09:48:40 +00:00
dependabot[bot]
e8ba44167c
Bump path-parse from 1.0.6 to 1.0.7 (#699) 
Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7.
- [Release notes](https://github.com/jbgutierrez/path-parse/releases)
- [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7)

---
updated-dependencies:
- dependency-name: path-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2022-03-08 09:42:57 +00:00
dependabot-preview[bot]
444512c06a
[Security] Bump ini from 1.3.5 to 1.3.8 (#511) 
Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.8. **This update includes a security fix.**
- [Release notes](https://github.com/isaacs/ini/releases)
- [Commits](https://github.com/isaacs/ini/compare/v1.3.5...v1.3.8)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Patrick Marsceill <pmarsceill@users.noreply.github.com>
 2022-03-08 09:36:15 +00:00
dependabot-preview[bot]
ac91b2dd1c
[Security] Bump lodash from 4.17.19 to 4.17.21 (#640) 
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.19 to 4.17.21. **This update includes a security fix.**
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.19...4.17.21)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: Patrick Marsceill <pmarsceill@users.noreply.github.com>
Co-authored-by: Matt Wang <matt@matthewwang.me>
 2022-03-08 09:29:06 +00:00
Patrick Marsceill
89fb42dc66
Merge pull request #641 from just-the-docs/dependabot/npm_and_yarn/hosted-git-info-2.8.9 
[Security] Bump hosted-git-info from 2.7.1 to 2.8.9
 2022-03-08 04:20:11 -05:00
Matt Wang
9fa3a0fc5f
Merge branch 'main' into dependabot/npm_and_yarn/hosted-git-info-2.8.9 2022-03-08 01:15:41 -08:00
Matt Wang
577b9c5862
Merge branch 'main' into dependabot/add-v2-config-file 2022-03-07 17:34:52 -08:00
Doug Aitken
0f3d0e8285
Merge pull request #782 from dougaitken/dougaitken-fix-images 
Fix images in Markdown kitchen sink
 2022-03-06 12:48:57 +00:00
Doug Aitken
37e90d2676 change small-image 
Changed small-image to match large image and fix reference
 2022-03-06 12:20:58 +00:00
Doug Aitken
655335d552 Rename large file and fix reference 
Renaming the large image and changed the index test references to display these images
 2022-03-06 12:04:39 +00:00
Doug Aitken
ee47119f31
Adding large image for index text 
Remote image here is not loading - https://just-the-docs.github.io/just-the-docs/docs/index-test/#large-image

via https://www.flickr.com/photos/97810305@N08/9401451269
 2022-03-06 11:53:01 +00:00
Patrick Marsceill
4dedfe0b50
Merge pull request #606 from just-the-docs/dependabot/npm_and_yarn/y18n-3.2.2 
[Security] Bump y18n from 3.2.1 to 3.2.2
 2022-03-04 13:40:16 -05:00
Patrick Marsceill
7e111fa8c2
Merge branch 'main' into dependabot/npm_and_yarn/hosted-git-info-2.8.9 2022-03-04 13:37:02 -05:00
Patrick Marsceill
1032a0aae3
Merge branch 'main' into dependabot/npm_and_yarn/y18n-3.2.2 2022-03-04 13:35:09 -05:00
Patrick Marsceill
25aa612617
Merge pull request #778 from just-the-docs/fix-toc-on-index 
Fix ol on index
 2022-03-03 15:23:39 -05:00
Patrick Marsceill
bc4a91c61a Fix ol on index 2022-03-03 19:56:19 +00:00
Patrick Marsceill
fbf125d525
Merge pull request #777 from just-the-docs/readme-update 
Update readme
 2022-03-03 14:52:21 -05:00
Patrick Marsceill
265e88ed7a Update readme 2022-03-03 19:45:05 +00:00
Patrick Marsceill
501c007da1
Merge pull request #776 from just-the-docs/default-branch-refs 
rename master -> main
 2022-03-03 14:38:00 -05:00
Patrick Marsceill
79f30a22bc fix prettier bugs, remove prettier from MD formatting 2022-03-03 19:32:25 +00:00
Patrick Marsceill
13298d20c0 rename master -> main 2022-03-03 19:05:50 +00:00
Patrick Marsceill
7631aaa309
Merge pull request #775 from just-the-docs/update-repo-ref 
Update to new repo path
 2022-03-03 14:03:28 -05:00
Patrick Marsceill
fac7af13c1 update bundler 2022-03-03 18:54:58 +00:00
Patrick Marsceill
2aa9815064 Update to new repo path 2022-03-03 18:50:33 +00:00
dependabot-preview[bot]
978846f704
[Security] Bump hosted-git-info from 2.7.1 to 2.8.9 
Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.7.1 to 2.8.9. **This update includes a security fix.**
- [Release notes](https://github.com/npm/hosted-git-info/releases)
- [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md)
- [Commits](https://github.com/npm/hosted-git-info/compare/v2.7.1...v2.8.9)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
 2021-05-07 17:46:01 +00:00
dependabot-preview[bot]
c2f78516b4
Upgrade to GitHub-native Dependabot 2021-04-22 22:47:23 +00:00
dependabot-preview[bot]
04ae951436
[Security] Bump y18n from 3.2.1 to 3.2.2 
Bumps [y18n](https://github.com/yargs/y18n) from 3.2.1 to 3.2.2. **This update includes a security fix.**
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
 2021-03-29 17:22:10 +00:00
Patrick Marsceill
e842498637
Update publish-gem.yml 2020-10-14 13:23:05 -04:00
Patrick Marsceill
7f5ebee9b8
Delete publish.yml 2020-10-14 13:22:34 -04:00
Patrick Marsceill
cb7df09c8f
Update package.json 2020-10-14 13:21:02 -04:00
Patrick Marsceill
8bc53f8f45
Bump gem spec 2020-10-14 13:20:46 -04:00