Skip to content
Snippets Groups Projects
  1. Sep 14, 2020
  2. Sep 11, 2020
    • PLanCompS's avatar
      Update linenos.md · d59887cc
      PLanCompS authored
      doc for turning on kramdown linenos globally corrected/
      d59887cc
    • PLanCompS's avatar
      Update navigation-structure.md · ddccec7b
      PLanCompS authored
      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.)
      ddccec7b
    • PLanCompS's avatar
      Updated tests activation documenation · cd8d1739
      PLanCompS authored
      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.
      cd8d1739
  3. Aug 26, 2020
  4. Aug 13, 2020
  5. Aug 11, 2020
    • PLanCompS's avatar
      Update navigation-structure.md · cff0254d
      PLanCompS authored
      Adjusted the documentation to explain how mixtures of numbers and strings are treated by `nav_order`.
      cff0254d
    • PLanCompS's avatar
      Separate sorting of numbers and strings for navigation order · 4fc59a57
      PLanCompS authored
      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`.
      4fc59a57
  6. Aug 10, 2020
    • PLanCompS's avatar
      74da664c
    • PLanCompS's avatar
      Ensure pages with nav_exclude are ignored by navigation · 83ec5533
      PLanCompS authored
      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,.
      83ec5533
  7. Aug 06, 2020
  8. Aug 03, 2020
    • PLanCompS's avatar
      Adjust dl layout · 9fca3861
      PLanCompS authored
      Works for description lists with multiple `dt` and `dd` elements.
      9fca3861
  9. Jul 27, 2020
  10. Jul 10, 2020
  11. Jul 09, 2020
  12. Jul 07, 2020
    • PLanCompS's avatar
      Optimisations · 8a9a8a34
      PLanCompS authored
      Optimised CSS selectors.
      Changed markup in `linenos-test` to inhibit line numbers appearing in YAML examples when testing code fences.
      8a9a8a34
    • PLanCompS's avatar
      Major refactoring · 61053f67
      PLanCompS authored
      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).
      61053f67
  13. Jul 06, 2020
  14. Jul 04, 2020
  15. Jun 30, 2020
  16. Jun 27, 2020
  17. Jun 25, 2020
  18. Jun 18, 2020
  19. Jun 01, 2020
  20. May 05, 2020
  21. May 02, 2020
    • PLanCompS's avatar
      Update documentation with collapsible TOC · e40ba9c6
      PLanCompS authored
      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.
      e40ba9c6
  22. May 01, 2020
  23. Apr 28, 2020
  24. Apr 25, 2020
    • PLanCompS's avatar
      Made case-insenstive sorting the default · c46ccd34
      PLanCompS authored
      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`.
      c46ccd34
  25. Apr 24, 2020
Loading