steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-09-13 05:13:33 -06:00
Code Issues Packages Projects Releases Wiki Activity
1,012 Commits 8 Branches 50 Tags
70b34f01f7355fc0850333ac08668a70c3faae2d
Commit Graph

156 Commits

Author SHA1 Message Date
Peter Mosses
70b34f01f7 Combination (#578) 
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](https://github.com/pmarsceill/just-the-docs/pull/462) and (NEW:) [sibling links](https://github.com/pmarsceill/just-the-docs/pull/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 <matt@matthewwang.me>
 2022-07-04 12:15:10 -07:00
Michelle Blanchette
260d98d825 remove extra spaces (#554) 
Co-authored-by: Matt Wang <matt@matthewwang.me>
 2022-03-09 10:36:09 -08: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
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
2aa9815064 Update to new repo path 2022-03-03 18:50:33 +00:00
Peter Mosses
5665097fc2 Update configuration.md 
2019 replaced by 2020 in line 94.
 2020-10-13 09:40:33 +02:00
Patrick Marsceill
487a5a680a Update configuration.md 2020-10-12 14:15:12 -04:00
Patrick Marsceill
bd1f741d6d Merge pull request #334 from CodeSandwich/custom_header_footer 
Add custom header and footer include files
 2020-10-12 12:57:25 -04:00
Patrick Marsceill
fdb93755d1 Update configuration.md 2020-10-12 12:49:51 -04:00
Patrick Marsceill
58aea7a29b Update configuration.md 2020-10-12 12:47:56 -04:00
Patrick Marsceill
863d13fc8e Merge pull request #443 from pdmosses/nav-exclude 
Limit the effect of `nav_exclude` to the main navigation
 2020-10-12 12:41:33 -04:00
PLanCompS
59f757a790 Fix list alignment 
Resolve #420

- Remove `margin-top` for the first child in various list items, to improve alignment.
- Add examples of lists to `docs/tests/styling`.
 2020-09-29 17:13:13 +02:00
PLanCompS
641fa6ac5c Create excluded.md 
Add a test for explicit exclusion of an untitled page.
 2020-09-28 17:26:51 +02:00
PLanCompS
09ab1c3131 List children also when excluded from main navigation 
- Limit the effect of `nav_exclude: true` to the main navigation.
- Include links to excluded pages in auto-generating lists of child pages
and in breadcrumbs.
- Refactor implementation by moving assignment of `first_level_url` and `second_level_url` from `_includes/nav.html` to `_layouts/default.html`.
- Clarify the effect of `nav_exclude` in the documentation.
 2020-09-28 17:06:06 +02:00
PLanCompS
682dcf4ec1 Folders renamed 
Improve folder names.
Correct classification of excluded test pages.
 2020-09-28 16:54:07 +02:00
PLanCompS
405180c863 Reorganise tests 
Make the titles of test pages more suggestive.
Refactor the documentation of the tests.
 2020-09-28 16:37:42 +02:00
PLanCompS
aa247408e4 Tests updated 2020-09-28 12:08:27 +02:00
Igor Żuk
b89ab93a88 Merge branch 'master' into custom_header_footer 2020-09-15 00:09:50 +02:00
Patrick Marsceill
1f30d6bf78 Update line-nos.md 2020-09-14 13:29:09 -04:00
Patrick Marsceill
916a9256b1 Forgot this too 2020-09-14 13:24:10 -04:00
Patrick Marsceill
84e67c34b7 Forgot to remove this 2020-09-14 13:19:33 -04:00
Patrick Marsceill
1b0a313c16 Make examples more clear 2020-09-14 12:54:55 -04:00
Patrick Marsceill
c587c0b217 Fix heading hierarchy 2020-09-14 12:46:26 -04:00
Patrick Marsceill
e4246b35b0 Update permalink 2020-09-14 12:43:59 -04:00
Patrick Marsceill
68d5c56cf3 Move this down 2020-09-14 12:40:17 -04:00
Patrick Marsceill
020a50acff Update docs/tests/navigation/exclude/untitled.md 
Co-authored-by: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
 2020-09-14 10:57:42 -04:00
Patrick Marsceill
5cc5ae5edf Merge pull request #418 from mrfleap/master 
Add site.gh_edit_source to "Edit this page on GitHub" link
 2020-09-11 17:00:29 -04:00
PLanCompS
d59887cc2b Update linenos.md 
doc for turning on kramdown linenos globally corrected/
 2020-09-11 19:42:44 +02:00
PLanCompS
ddccec7bb7 Update navigation-structure.md 
Reinstated the collapsible TOC at the top, to support the reference to it right at the end of the file. (The `TOC` feature can only be used once per page, so this is the only way of illustrating the rendering of the collapsible TOC in the docs.)
 2020-09-11 18:57:57 +02:00
PLanCompS
cd8d173935 Updated tests activation documenation 
Apparetnly Jekyll's `include` config option cannot be used to override an `exclude`, so activating `docs/tests/` requires commenting-out that line in the `exclude` list.
 2020-09-11 18:54:32 +02:00
PLanCompS
02763e69d9 Merge branch 'master' into nav-sorting 2020-09-11 18:49:44 +02:00
Patrick Marsceill
d0a9cd38dd Merge pull request #404 from pdmosses/h4-code 
Inhibit text-transform for code in h4
 2020-09-11 11:51:02 -04:00
Patrick Marsceill
322026633f Merge pull request #331 from hvianna/master 
Fix native font stack precedence issue on Windows systems.
 2020-09-11 11:48:54 -04:00
Patrick Marsceill
db32b66ce9 Merge pull request #375 from pdmosses/linenos 
Support for the linenos option on highlighted code
 2020-09-11 10:59:13 -04:00
Phillip Cutter
cdfad69c5b Migrated from site.source to site.gh_edit_source 2020-08-25 18:08:31 -07:00
PLanCompS
ca367e09d5 Added regression tests for navigation 
See the change to `_config.yml` for how to activate the tests.
 2020-08-13 16:52:30 +02:00
PLanCompS
591a3c2351 Update navigation-structure.md 
Clarifications
 2020-08-13 16:48:45 +02:00
PLanCompS
cff0254d93 Update navigation-structure.md 
Adjusted the documentation to explain how mixtures of numbers and strings are treated by `nav_order`.
 2020-08-11 20:47:22 +02:00
PLanCompS
4fc59a578f Separate sorting of numbers and strings for navigation order 
The values of `title` and `nav_order` can be numbers or strings.
Jekyll gives build failures when sorting on mixtures of different types,
so numbers and strings need to be sorted separately.

Here, numbers are sorted by their values, and come before all strings.
An omitted `nav_order` value is equivalent to the page's `title` value
(except that a numerical `title` value is treated as a string).

The case-sensitivity of string sorting is determined by `site.nav_sort`.
 2020-08-11 18:25:58 +02:00
PLanCompS
74da664c0a Linenos test moved to UI Components as a child of Code 2020-08-10 16:53:48 +02:00
Patrick Marsceill
6be8a2e38a Merge pull request #379 from SgtSilvio/feature/doc-collections 
Feature/doc collections
 2020-08-10 10:42:30 -04:00
PLanCompS
83ec553348 Ensure pages with nav_exclude are ignored by navigation 
Pages with `nav_exclude: true` were included when sorting on `title` or `nav_order`. That could cause build failures when the type of value of the field differs from that on other pages, as reported in https://github.com/pmarsceill/just-the-docs/issues/406.

Pages with `nav_exclude: true` or no `title` are never displayed in the navigation, so removing them from `pages_list` cannot break existing sites. This change also allows the removal of some tests in the code. (The indentation of the code should now be adjusted, but that has been deferred, to restrict the size of the diff for review.)

For testing, the title of `404.html` has been changed to the number `404`,  the page `docs/untitled-test.md`  has been added, and `nav_sort_order` has been set to `case_sensitive`. Those updates give build failures with the current version of `_includes/nav.html`, but not after the suggested changes.

It will still be possible for build failures to occur due to sorting fields of *non-excluded* pages with differing types of values (e.g., `nav_order`a mixture of numbers and strings). To make the code completely safe will require relatively complicated changes,.
 2020-08-10 15:58:42 +02:00
PLanCompS
98b22be66b Inhibit text-transform for code in h4 
Tested in `index-test.md`

Fixes #403
 2020-08-06 10:04:43 +02:00
PLanCompS
9fca3861ce Adjust dl layout 
Works for description lists with multiple `dt` and `dd` elements.
 2020-08-03 17:38:48 +02:00
CodeSandwich
cd192aa4e2 Add custom header and footer include files 2020-07-26 00:35:58 +02:00
Henrique Vianna
8ff2e57796 Merge branch 'master' into master 2020-07-16 15:11:00 -03:00
Silvio Giebl
a086954c51 Improved documentation for document collections 2020-07-10 21:05:29 +02:00
Silvio Giebl
b32c00a701 Improved documentation of just-the-docs.collections nav_exclude and search_exclude 2020-07-10 20:36:05 +02:00