Giter Club home page Giter Club logo

Comments (4)

katrpilar avatar katrpilar commented on May 18, 2024 1

@Corey-Albright-OnTheClock I absolutely had to have the ability to navigate between markdown anchor links from child navigation items in the main menu as well. After a lot of trial and error, I figured out a way to do this without reloading the current parent view. I have twice as many anchor sections under Core Concepts than listed here. So, naturally, I wanted to improve navigation to each section without separating each section into its own markdown file OR having to reload the page to link to these section in the child menu navigation. (just as you have described)

My menu structure looks like this:

  • About
    • Core Concepts
      • Data Flow
      • Object Types
      • Authentication
      • Pagination
      • Error Handling
      • Data Flow
      • Configurations
      • Filters

My Solution

Given the above structure, my solution was to create a folder sectionAnchors in the same file location of the parent navigation page coreConcepts.md. Then, I created the empty (except config) markdown files with for each of the sections inside the sectionAnchors folder. The key here is to NOT provide a layout in the placeholder empty config child sectionAnchors markdown files as shown below in the dataFlow.md example.

coreConcepts.md (Parent)

---
layout: page
title: Core Concepts
permalink: /about/concepts
parent: About
nav_order: 2
has_children: true
---

## Data Flow
A ton of text and explanations of how to understand the data flow.

dataFlow.md (coreConcepts's child anchor link)

---
title: Data Flow
permalink: /about/concepts#data-flow
parent: Core Concepts
nav_order: 1
---

Note

Local and published anchor permalinks seem to behave slightly differently for some reason and require an extra / before the # when running things locally for this to work? (see below).

Published: Github Pages

/about/concepts#data-flow

Local: bundle exec jekyll serve.

/about/concepts/#data-flow

from just-the-docs.

Corey-Albright-OnTheClock avatar Corey-Albright-OnTheClock commented on May 18, 2024

I am considering the following alternatives:

  • refresh page after 1 second and goes to permalink (long handed and tedious)
    -- parent page to include page with refresh to 1 second on running page that would link to the insertion point for the div
  • Editing file:
    -- nav.html

from just-the-docs.

Corey-Albright-OnTheClock avatar Corey-Albright-OnTheClock commented on May 18, 2024

A perfect example:
Navigation Structure
would be to put the TOC within the section: all of the TOC on left side within the section called Navigation Structure

Like:

Navigation Structure:
--> Main navigation
Ordering pages
Excluding pages
Pages with children
Child pages
Auto-generating Table of Contents
Children with children
Auxiliary Navigation
In-page navigation with Table of Contents

^ On left side / main nav under Navigation Structure

from just-the-docs.

pmarsceill avatar pmarsceill commented on May 18, 2024

This is not something we will support out-of-the-box at this time.

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.