Combination #578
Merged
Combination #578
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move highlighting colours from `code.scss` to `light.scss`. Add GitHub Dark hihlighting colurs to `dark.scss`. Test using `Preview dark...` button in Configuration page.
- Move `docs/tests` pages to `_tests` collection. - Create `_tests_config.yml` to include tests. - Update `_cnfig.yml` instructions for including tests. - Update links in `_tests/navigation/index.md`. - Update `_layout/default.html` to output site.html_pages and/or collections. - Test by running `bundle exec jekyll serve --config _tests_config.yml`.
- Discount excluded pages
- Update the section on configuration of collections to include normal pages.
- Add copies of CSS files from Pygments - Replace GitHub Dark colours in _sass/color_schemes/dark.scss by an import
- Avoid irrelevant conflicts when updating from master
- Remove duplicated configuration code from `_tests_config.yml` - Rename to `_tests.yml` The tests collection is ignored when not mentioned, so it does not need to be excluded in `_config.yml`.
- Add various examples of callout configurations - Add Liquid code for generating SCSS for each callout - Add a test file for callouts
- Restrict callouts to paragraphs and blockquotes. - Add `div.opaque` style. - Revert default opacity to 0.2. - Add a highlight callout. - Update configuration and customization docs. - Update styling tests..
- Remove outdated comments.
- Add a `custom` callout using a new color `pink`. - Update the docs for configuration and customization.
- Fix a bug with the breadcrumbs list, where a link on a grandchild page can point to the wrong parent page, following the solution suggested by @AdityaTiwari2102 in just-the-docs#477
The TOC/breadcrumb links in "Tests" and "Test Collection 1" exhibit the bug reported in just-the-docs#492. To fix the bug, this PR needs merging with just-the-docs#494.
Correct the dark code highlighting: - Change the extension of the imported CSS file to `scss`. - Remove unused `pygments` folders and files. Dark code highlighting tested with Jekyll 3.8.7 and 4.1.1.
Fixes just-the-docs#488. - Replace `''` by `""` in rake script and resulting search data file. Tested on macOS Catalina.
Fix just-the-docs#491 - Restrict an `li` style to direct descendants. - Add the examples from just-the-docs#491 to the regression tests
- Add a test for 6 levels of nested ordered list.
- Replace the test for 6 levels or ordered list by a test checking the couoters for 3 levels.
Fix just-the-docs#497 - Insert `color: $body-text-color;` in styling for `search-input`.
Prettier
Implement enhancement suggested by @mattjlewis in just-the-docs#171 - Generate CSS for `.*-title` callouts - Add examples of markup for title customisation
Serve locally: ``` bundle exec jekyll serve --config _config.yml,_config_dev.yml ``` Test locally: ``` bundle exec jekyll serve --config _config.yml,_config_dev.yml,_tests.yml ```
- Fix a bug that affects sites with no child pages
This was referenced Jul 4, 2022
Closed
Closed
Closed
Closed
This was referenced Jul 28, 2022
Merged
kevinlin1
added a commit
to kevinlin1/just-the-class
that referenced
this pull request
Sep 13, 2022
pdmosses
added a commit
to pdmosses/just-the-docs
that referenced
this pull request
Sep 24, 2022
Extension of PR just-the-docs#977 to v0.4.0.rc1: - Make callouts `loud`. - Replace a warning paragraph by a callout. - Use a reference link instead of an explicit url for @pmarsceill . - Add link reference definitions for PRs and new contributors in v0.4.0.rc1. - Replace inline urls by shortcut link references. The changes to replace URLs by link references would be too tedious and error-prone to do completely manually for v0.4.0.rc1. The following regexp replacements were applied to the sections of v0.4.0.rc1, using Atom: - Copy a section of changes. - In the copy, replace `.*(https://.*pull/)([0-9]+).*$` by `[#$2]: $1$2`. - In the original, replace `(https://.*pull/)([0-9]+)` by `[#$2]`. - Copy a section of new contributors. - In the copy, replace `\* @([^ ]+) .*$` by `[@$1]: https://githhub.com/$1`. - In the original, replace `@([a-zA-Z0-9]+)` by `[@$1]`. Add (co)authors in [just-the-docs#578]: * [@AdityaTiwari2102] made their first contribution in [just-the-docs#477] * [@svrooij] made their first contribution in [just-the-docs#544] [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102 [@svrooij]: https://githhub.com/svrooij To test: 1. Check that the CHANGELOG contents looks the same in the docs and in the repo (apart from the callouts) with clickable links to all PRs and contributors for v0.4.0.rc1. 2. Check that none of the lines with changes or new contributors have been removed.
mattxwang
pushed a commit
that referenced
this pull request
Sep 26, 2022
* Make more CHANGELOG urls clickable Extension of PR #977 to v0.4.0.rc1: - Make callouts `loud`. - Replace a warning paragraph by a callout. - Use a reference link instead of an explicit url for @pmarsceill . - Add link reference definitions for PRs and new contributors in v0.4.0.rc1. - Replace inline urls by shortcut link references. The changes to replace URLs by link references would be too tedious and error-prone to do completely manually for v0.4.0.rc1. The following regexp replacements were applied to the sections of v0.4.0.rc1, using Atom: - Copy a section of changes. - In the copy, replace `.*(https://.*pull/)([0-9]+).*$` by `[#$2]: $1$2`. - In the original, replace `(https://.*pull/)([0-9]+)` by `[#$2]`. - Copy a section of new contributors. - In the copy, replace `\* @([^ ]+) .*$` by `[@$1]: https://githhub.com/$1`. - In the original, replace `@([a-zA-Z0-9]+)` by `[@$1]`. Add (co)authors in [#578]: * [@AdityaTiwari2102] made their first contribution in [#477] * [@svrooij] made their first contribution in [#544] [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102 [@svrooij]: https://githhub.com/svrooij To test: 1. Check that the CHANGELOG contents looks the same in the docs and in the repo (apart from the callouts) with clickable links to all PRs and contributors for v0.4.0.rc1. 2. Check that none of the lines with changes or new contributors have been removed. * Revert to quiet callouts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR combines (and resolves conflicts between) #448, #463, #466, #494, #495, #496, #498, and #572.
The main aim is to facilitate use of several of the implemented features together, when using the fork as a remote theme. It should also simplify merging the included PRs into a future release.
The branch combination-rec-nav adds multi-level navigation and (NEW:) sibling links to the branch used for this PR. It includes updated documentation for the navigation structure, and reorganised and extended navigation tests. The documentation and the tests can be browsed at the (temporary) website published from the combination-rec-nav branch.
Caveat: The changes to v0.3.3 in this PR and #462 have not yet been reviewed or approved, and may need updating before merging into a release of the theme. If you use a branch from a PR as a remote theme, there is a risk of such updates affecting your website. Moreover, these branches are likely to be deleted after they have been merged. To avoid such problems, you could copy the branch that you want to use to your own fork of the theme.