Commit Graph

178 Commits

Author SHA1 Message Date
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
Silvio Giebl 7dec48433b Improved documentation for doc_collections 2020-07-09 23:51:31 +02:00
Silvio Giebl b4b74f7e1d Added documentation for doc_collections 2020-07-09 23:43:33 +02:00
PLanCompS 8a9a8a345d Optimisations
Optimised CSS selectors.
Changed markup in `linenos-test` to inhibit line numbers appearing in YAML examples when testing code fences.
2020-07-07 19:54:31 +02:00
PLanCompS 61053f677b Major refactoring
The additions to `_config.yml` go together with the changes to `code.scss`,
to facilitate adjusttments by users. See `docs/linenos-test` for the details.
The CSS code has been significantly refactored and simplified,
and seems to produce sensible results (at least on Safari and Firefox).
2020-07-07 19:34:35 +02:00
PLanCompS fdaf5a276b Moved tests from index-test.md to linenos-test.md
This should revert the changes made to index-test.md
2020-07-06 15:04:30 +02:00
PLanCompS b41f28dade Support for the linenos option on highlighted code
The added examples in `docs/index-test.md` extend the previous examplees of highlighting, documenting the required inout.
2020-07-04 19:21:49 +02:00
Patrick Marsceill 1bdd849d86
Update navigation-structure.md 2020-06-30 13:58:26 -04:00
Patrick Marsceill 2101701aad
Merge branch 'master' into pdmosses-collapsible-toc 2020-06-30 13:42:36 -04:00
Patrick Marsceill 845261205f
Make cursor pointer, update docs, and add heading 2020-06-30 13:03:17 -04:00
Patrick Marsceill c8bbcc2d9b
Merge branch 'collapsible-toc' of git://github.com/pdmosses/just-the-docs into pdmosses-collapsible-toc 2020-06-30 12:54:51 -04:00
Henrique Vianna 72b6de8862 Updated native font stack, as suggested in https://github.com/pmarsceill/just-the-docs/issues/330#issuecomment-650415240 2020-06-27 17:37:39 -03:00
Henrique Vianna 1f492b68f3 Merge remote-tracking branch 'upstream/master' 2020-06-27 17:34:59 -03:00
Silvio Giebl 3f0b7254a2 Update _config.yml with default values 2020-06-25 23:19:24 +02:00
Silvio Giebl 868bb0e3ac
Apply suggestions from code review
Co-authored-by: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-06-25 23:11:43 +02:00
Silvio Giebl 1cf7d5aba9 Restored search.rake 2020-06-18 22:39:58 +02:00
Silvio Giebl 51f15965f2 Merge branch 'feature/search-sections' into improvement/navigation-new
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
#	assets/js/search-data.json
#	docs/configuration.md
#	lib/tasks/search.rake
2020-06-15 22:06:16 +02:00
Henrique Vianna 7cfc63e138 Fix native font stack precedence issue on Windows systems. 2020-06-01 14:35:15 -03:00
Patrick Marsceill 6345c61aae
Clean up typography updates 2020-05-05 12:48:45 -04:00
PLanCompS e40ba9c6c5 Update documentation with collapsible TOC
Makes the TOC at the top of the page collapsible.
Adds an explanation of the markup used to produce a collapsible TOC.
Adds a comment about the possibility of using an unordered list for the TOC,
and about using TOC only once per page.
2020-05-02 14:39:31 +02:00
Patrick Marsceill 411c508806
Add additional layout and text justifcations 2020-05-01 15:32:42 -04:00
Patrick Marsceill 2f13db1f01
Make code font size dynamic 2020-05-01 15:07:27 -04:00
Patrick Marsceill ff5047e523
Fix outdated docs
closes #266
2020-05-01 14:55:40 -04:00
Peter Mosses 561f930e83
Update navigation-structure.md
Deleted a spurious line from a previous version.
2020-04-28 17:33:59 +02:00
Patrick Marsceill 41a74d247d
Update docs/navigation-structure.md
Co-Authored-By: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
2020-04-28 10:58:07 -04:00
Matt Wang 6d487845a4
Merge branch 'v0.2.9' into aux-links-new-tab 2020-04-27 13:00:42 -07:00
Patrick Marsceill fad434bc74
Merge branch 'v0.2.9' into default-nav-order 2020-04-27 11:05:46 -04:00
PLanCompS c46ccd3484 Made case-insenstive sorting the default
Added a configuration option to determine whether the sort order is case-sensitive.
The default is case-insensitive.

To test:
- open `/just-the-docs/docs/utilities/` in the browser,
  and check that the navigation links in `Utilities` are sorted alphabetically;
- in `docs/utilities/layout.md', change the preamble to `title: layout`,
  and check that the  links in `Utilities` are still sorted alphabetically;
- add `nav_sort: case_sensitive` in the configuration file,
  and check that the link to `layout` is now listed last under `Utilities`.
2020-04-25 14:53:45 +02:00
Patrick Marsceill 59d4802ce3
Merge branch 'improvement/custom-themes' of git://github.com/SgtSilvio/just-the-docs into SgtSilvio-improvement/custom-themes 2020-04-24 15:39:44 -04:00
Patrick Marsceill 0716ea77d6
Merge pull request #250 from Labs64/pr-anonymize_ip
Enable IP anonymization in Google Analytics (GDPR)
2020-04-24 14:47:21 -04:00
R.Brown 5152912e5c
Update docs/configuration.md
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-24 19:44:34 +02:00
Patrick Marsceill 9f6a700d6e
Update configuration.md 2020-04-23 22:44:07 -04:00
Patrick Marsceill 60756a592d
Update configuration.md 2020-04-23 22:41:29 -04:00
Silvio Giebl f5e6573e16 Removed unnecessary rake command and files
Improved search documentation
2020-03-25 00:23:17 +01:00
Matthew Wang 9b86e292fa implements requested branch and edit mode configs 2020-01-12 13:47:05 -08:00
Silvio Giebl f1c306c814 Multi search match highlight
Added multiple previews, configurable by site.search.previews
Improved search-data.json
2020-01-02 11:55:38 +01:00
Silvio Giebl 82b3f15443 Added search.button configuration
Improved documentation for search configurations
2019-12-29 21:30:44 +01:00
Silvio Giebl 2ef0029068 Add documentation for search configurations 2019-12-29 21:08:15 +01:00
Silvio Giebl 03979bf8fc Added documentation for custom color schemes and custom css 2019-11-27 11:15:57 +01:00
Silvio Giebl bb0e5222ca Merge branch 'master2' into improvement-custom-themes-merged 2019-11-26 23:27:33 +01:00
Alexey Averikhin 25331a5ffa Enable IP anonymization in Google Analytics (GDPR)
- Introduced "ga_tracking_anonymize_ip" parameter to enable/disable Google Analytics IP anonymization (to comply with GDPR).

(cherry picked from commit ce530f36fa0549c78ffe53ea6077f44f6f0b330f) (+1 squashed commit)
Squashed commits:
[69b7718] - enable GA anonymize_ip

(cherry picked from commit f2b67c632af72b61dd634b9a337200781519691e)
2019-11-12 10:27:01 +01:00
Peter Mosses 06853e895a Update navigation-structure.md
Added documentation of default nav order.
2019-10-11 23:02:19 +01:00
Peter Mosses 210e060f18 Testing default nav order
The `nav_order` fields are removed from the children of the Utilities node, which results in alphabetic order.
2019-10-11 21:43:07 +01:00
Matthew Wang 5549a15df9 adds option to make aux links open in new tab 2019-10-01 22:22:34 -07:00
Matthew Wang e917ea1f10
Merge branch 'master' into master 2019-09-11 15:40:51 -07:00
Matthew Wang 4ff38dbe9c adds documentation 2019-09-11 15:36:36 -07:00
Patrick Marsceill c5e53d90c9
Update customization.md 2019-09-10 11:36:48 -04:00
Patrick Marsceill b49829c784
Update search.md 2019-09-10 11:26:14 -04:00
Patrick Marsceill dbac62127a
Merge branch 'v0.2.7-release' into change-theme-button-text 2019-09-09 16:06:21 -04:00
Patrick Marsceill 850a8fe256
Merge pull request #203 from pdmosses/search-config
Search config
2019-09-09 16:00:11 -04:00
Peter Mosses 1564ca4511 Update configuration.md
Added documentation for `search_tokenizer_separator`.
2019-09-09 21:50:05 +02:00
Patrick Marsceill 3b42ec2762
Merge pull request #206 from iamcarrico/allow-for-overrides
Allow for custom overrides by the user
2019-09-09 15:35:31 -04:00
Patrick Marsceill 843233c6b2
Merge pull request #187 from SgtSilvio/improvement/site-logo
Improvement/site logo
2019-09-09 15:10:55 -04:00
Ian Carrico 1aee233e1f Add in some docs 2019-09-04 09:04:10 -04:00
Peter Mosses 50cdf076b4 Add configuration option search_tokenizer_separator
The default is for hyphens to separate tokens in search terms: `gem-based` is equivalent to `gem based`.

This adds `search_tokenizer_separator` as a site configuation option, to support search for hyphenated words.
2019-08-29 15:36:13 +02:00
Peter Mosses 5b74b44230 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-29 14:42:23 +02:00
Peter Mosses 5e72b7db67 Revert "Revert "Optional delay of grandchildren link display""
This reverts commit 89f79138c3.
2019-08-29 14:41:09 +02:00
Peter Mosses 89f79138c3 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-22 21:37:11 +02:00
Peter Mosses 8ac545a5eb Optional delay of grandchildren link display
The current default is that when a grandparent is selected, the links to its
children *and all its grandchildren* are displayed in the navigation menu.
Setting `grandchildren_branch: true` in `_config.yml` delays the display of links
to grandchildren until their parent is selected.
2019-08-21 13:49:07 +02:00
Silvio Giebl 91760ee8c9 Added documentation for logo variable 2019-08-17 14:46:28 +02:00
Silvio Giebl cba53a6914 Make themes more customizable
(cherry picked from commit dffb2706a158784e2f3091f895a868e373683bc8)
2019-08-15 18:35:10 +02:00
Manu de37d60720 Recommend using index.md as parent page for sections
Using `index.md` as name for the parent page within a section allows lazy developers
to skip defining `permalink`. This is already working and this PR just updates the documentation.
2019-08-15 09:38:44 +08:00
Patrick Marsceill 5ad439b53c
Merge branch 'v0.2.6-release' into improve-search 2019-08-14 11:03:30 -04:00
Patrick Marsceill f2cec110ff
Add footer content docs 2019-08-14 10:50:49 -04:00
Patrick Marsceill 225604723a
Fix docs and custom scss 2019-08-14 10:40:19 -04:00
Patrick Marsceill 3eadd49ee7
Fix new namespace on event 2019-08-14 10:08:01 -04:00
Patrick Marsceill 2b2ebf6033
Lint and docs 2019-08-13 17:24:23 -04:00
Patrick Marsceill b89b683f90
Add content footer 2019-08-06 15:56:29 -04:00
jacobherrington eabe7b2585 Change button copy on theme preview
This commit makes the dark mode preview feel a little more interactive
and it also pulls some duplicated code into one file so that people like
me aren't stumped when they are looking at the wrong page!
2019-06-21 18:19:49 -05:00
Silvio Giebl f4ee29d0c3 Fixed script tags 2019-05-19 02:55:43 +02:00
Patrick Marsceill 0ac8ec23bf
Support for nesting ul in ol and vice versa 2019-02-02 17:38:36 -06:00
Patrick Marsceill a8c282ae5a
Add docs for GA tracking 2019-02-02 12:32:33 -08:00
Florian Woerner 04e81c7158
Just fixing a typo in the layout example 2019-01-26 16:28:26 +01:00
EricFromCanada 60c82cb518 Allow for ampersand in title or URL
Because `page.title` (and `page.url`) is already escaped and page titles served by lunrjs do not need escaping, ampersands need to be unescaped to display properly in search results.
2019-01-16 00:31:30 -05:00
EricFromCanada 9a4ea76957 Improve search content generator 2019-01-15 22:54:30 -05:00
EricFromCanada 793ea356c3 Use `unless` loop for comma
and mention `search_exclude`
2019-01-15 20:48:52 -05:00
EricFromCanada 71ba32e131 Additional text fixes 2019-01-15 20:48:48 -05:00
EricFromCanada 2218e6e565 Fix links and syntax
For pages in utilities/, reorder `nav_order` to follow `parent`.
2019-01-14 14:43:33 -05:00
EricFromCanada ae5bcfe361 Fix grammar and capitalization 2019-01-14 14:43:29 -05:00