Skip to content

Conversation

@pmarsceill
Copy link
Collaborator

No description provided.

@mattxwang
Copy link
Member

Reviewed a couple of (what should be pretty trivial) one-liner and docs changes, and tagged them above - let me know which of these you think are suitable for v0.4.0!

(haven't merged them into main - not entirely sure how the release process works. Do you stage all changes into a new branch, and then merge it all at once?)

@pmarsceill
Copy link
Collaborator Author

pmarsceill commented Mar 9, 2022

Reviewed a couple of (what should be pretty trivial) one-liner and docs changes, and tagged them above - let me know which of these you think are suitable for v0.4.0!

(haven't merged them into main - not entirely sure how the release process works. Do you stage all changes into a new branch, and then merge it all at once?)

Thanks @mattxwang these all look good. You can merge them all into this v0.4.0 branch and then we stage them here.

pmarsceill and others added 7 commits March 9, 2022 11:48
Co-authored-by: Matt Wang <[email protected]>
Co-authored-by: Matt Wang <[email protected]>
* Set color for search input

Fix #497
- Insert `color: $body-text-color;` in styling for `search-input`.

* Update search.scss

Prettier
@mattxwang
Copy link
Member

mattxwang commented Mar 9, 2022

Thanks @mattxwang these all look good. You can merge them all into this v0.4.0 branch and then we stage them here.

Sounds good, have just done that. I'll flag a few more candidates for you over the next few days before merging. I've also updated the draft release with the relevant PRs.

Out of curiosity, is there a reason that we stage this way (with a branch)? And do you manually generate the messages for the release, or use a tool? I wonder if we should collate some of the smaller things (ex dependency updates or typo fixes).

@mattxwang mattxwang mentioned this pull request Mar 9, 2022
mattxwang and others added 2 commits April 18, 2022 10:53
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](https://github.com/pdmosses/just-the-docs/tree/combination-rec-nav) adds [multi-level navigation](#462) and (NEW:) [sibling links](#394) to the branch used for this PR. It includes updated [documentation for the navigation structure](https://pdmosses.github.io/just-the-docs/docs/navigation-structure/), and reorganised and extended [navigation tests](https://pdmosses.github.io/just-the-docs/tests/navigation/). The documentation and the tests can be browsed at the (temporary) [website published from the combination-rec-nav branch](https://pdmosses.github.io/just-the-docs/).

_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.

Co-authored-by: Matt Wang <[email protected]>
@mattxwang
Copy link
Member

Heads up - now that #578 is in, I'm going to be merging in all the other approved PRs, resolving conflicts when necessary.

nathanjessen and others added 16 commits July 4, 2022 12:22
These docs outline some of the custom includes that are provided by the theme and can be modified by the user.

Co-authored-by: Matt Wang <[email protected]>
Co-authored-by: Patrick Marsceill <[email protected]>
As is, this is invalid and will not cause the TOC to be rendered. The collapsing example is fine.

Co-authored-by: Matt Wang <[email protected]>
Co-authored-by: Peter Mosses <[email protected]>
Fix #517

Users expect nested task lists to have the same indentation as other lists.
Fix the styling in `_sass/content.scss` to do that.
Add examples in `docs/index-test.md` to test.
Fix #685
- Wrap scss file in comments with `{% raw %}` and `{% endraw %}` tags

Co-authored-by: Matt Wang <[email protected]>
* implements search placeholder configuration

* changes implementation approach to use search_placeholder_custom

Thanks to @pdmosses for the suggestion!

* strips whitespace and HTML for both placeholder and aria-label
Looking at how the variables are defined in _variables.scss, with various dependencies between them aimed at ensuring a consistent color scheme, one might expect that redefining a given variable would affect the remaining styles that depend on it.

This is not the case, however, due to the order in which the files are processed. This PR edits the documentation to mention the non-propagating behavior of redefined variables, to better guide users that wish to customize the site using custom themes, and call their attention to the need to redefine the dependency relations as well.

Co-authored-by: Matt Wang <[email protected]>
Co-authored-by: Patrick Marsceill <[email protected]>
…s in reverse (#726)

Set `child_nav_order` to `desc` to reverse the sort order for a child section.

Co-authored-by: Matt Wang <[email protected]>
Fixes #488.
- Replace `''` by `""` in rake script and resulting search data file.
Tested on macOS Catalina.
**Rationale**
I would like to customize the site footer content without needing to override the entire default layout. Ideally, I'd like to shorten the attribution to something like "Built with Just the Docs"

**Implementation**
Create a new `site_footer.html` include that users can override.

**Possible changes**
I debated whether or not the `<footer class="site-footer">` should be in/out of the include. I opted for placing it inside the include so I have the option of disabling the footer entirely by creating an empty site_footer file in my site.

Co-authored-by: Matt Wang <[email protected]>
Co-authored-by: Patrick Marsceill <[email protected]>
The anchor heading item is keyboard focusable, but when focused and not hovered, it is not visible. This PR fixes that. Also, great project!
I have a site whose content is written in AsciiDoc, using the [jekyll-asciidoc][] plugin.

Just the Docs works great, but there are just two minor styling glitches I've noticed:

The first is that Just the Docs' CSS doesn't understand the code block markup jekyll-asciidoc produces.  It's not too different though, so it's very easily fixed.

The second is that jekyll-asciidoc generates `div.sect(𝑛 − 1)` elements around headings of type `h𝑛`, that enclose all the heading and all the content after it until the next heading of greater or equal rank.

This means that headings are _always_ first children in AsciiDoc output, which meant the wrong margins were applied to most headings. To fix this, we need to only reduce the margin of first-child headings nested directly below the .main-content element, and headings nested directly below AsciiDoc `.sect𝑛` elements that are themselves first children.

With these two small changes, my site looks perfect, and the styles look exactly the same as on Just the Docs' own documentation.

[jekyll-asciidoc]: https://github.com/asciidoctor/jekyll-asciidoc
Closes #825


Co-authored-by: Matt Wang <[email protected]>
@mattxwang
Copy link
Member

@dougaitken
Copy link
Contributor

Incredibile work @mattxwang!

iridazzle and others added 3 commits July 21, 2022 11:09
without overflow-x: auto; a very long line of code will overflow the box and look awkward


Co-authored-by: Matt Wang <[email protected]>
@mattxwang mattxwang closed this Jul 23, 2022
@mattxwang mattxwang deleted the v0.4.0 branch July 23, 2022 04:44
@mattxwang
Copy link
Member

Closing this only to rename the target branch - please see #892.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.