Giter Club home page Giter Club logo

Comments (9)

gnarea avatar gnarea commented on May 21, 2024

@yavorg I experienced the same issue but didn't realise there was a newer version of the theme. That issue is fixed in newer versions.

This happened to me because I had both github-pages and just-the-docs in Gemfile. just-the-docs is downgraded to the latest version that's compatible with the version of Jekyll supported by github-pages. I created #117 to prevent future users from doing the same.

I'm not sure if that's what happened to you. But if it is, have a look at my Gemfile and _config.yml.

PS: What a small world! I think we overlapped at Auth0 -- your username rings a bell. :)

from just-the-docs.

yavorg avatar yavorg commented on May 21, 2024

Thanks for your help @gnarea... what a small world indeed!

Thanks for the pointer, I am now referencing the theme as remote_theme: "pmarsceill/[email protected]" in _config.yml as you suggested, instead of the Gemfile. This actually fixed my other issue #113, but I still can't get the nav_exclude to work.

from just-the-docs.

gnarea avatar gnarea commented on May 21, 2024

I'm glad that helped @yavorg!

It's weird that didn't fix the nav_exclude issue. I'm using nav_exclude: true in a few places (like this page) and it works as expected with the latest version of the theme (it didn't work with v0.1.6).

Just in case, make sure it isn't a caching issue. Many of the issues I've had with the sidebar navigation were fixed with a Shift + Refresh šŸ˜ƒ

Good luck! šŸ¤ž

from just-the-docs.

pmarsceill avatar pmarsceill commented on May 21, 2024

@yavorg are you still experiencing this issue? I'm struggling to reproduce it with the latest version of the theme.

from just-the-docs.

yavorg avatar yavorg commented on May 21, 2024

@pmarsceill still running into this even with 0.2.4

Gemfile

source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins

_config.yml

remote_theme: 'pmarsceill/[email protected]'
repository: '...'
title: '...'
description: '...'
permalink: pretty

# "Just the Docs" theme
search_enabled: true
aux_links:
    "...":
      - "..."
    "...":
      - "..."

Troubleshooting steps tried:

  • Deleted Gemfile.lock and reinstalled gems
  • Deleted _site before testing locally
  • Tried Incognito window

from just-the-docs.

pmarsceill avatar pmarsceill commented on May 21, 2024

Is your site on GitHub publicly? Iā€™d be curious to clone it down and try to reproduce myself.

from just-the-docs.

thealjey avatar thealjey commented on May 21, 2024

@pmarsceill the reason this issue exists (and I'm also experiencing it), is that _includes/nav.html is not recursive, for some reason (and that is why this whole nonsense with "grandparents" is even necessary, but that is a whole other problem), and only checks the top level item.
e.g. in your own documentation you can hide the "UI Components" menu item, but not its child - "Typography".
Furthermore, nav_exclude is completely ignored by the breadcrumbs and the TOC.
This, in my opinion, is the best and most versatile documentation theme for jekyll right now. And I've checked hundreds of them. So, props to you guys!
Let's hope it gets even better with time ;)
As for me, I'm seriously considering to start cranking out pull requests.

from just-the-docs.

DominicWatson avatar DominicWatson commented on May 21, 2024

I think this ticket should be re-opened (and then closed upon merging: #282 which fixes it for child navigation).

from just-the-docs.

okaykomputer avatar okaykomputer commented on May 21, 2024

For anyone encountering this issue in 2021 and your theme version contains merge #282, and no other solutions have worked for you, here's what fix worked for me (works for parent and all sub pages, and the table of contents)

In the _includes/nav.html file, find this:

  {%- assign titled_pages = include.pages
        | where_exp:"item", "item.title != nil" -%}

Change to this:

{%- assign titled_pages = include.pages
        | where_exp:"item", "item.title != nil and item.nav_exclude != true" -%}

from just-the-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    šŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. šŸ“ŠšŸ“ˆšŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ā¤ļø Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.