Nucleoid icon indicating copy to clipboard operation
Nucleoid copied to clipboard

Navigation problem

Open Gulshanaggarwal opened this issue 3 years ago β€’ 19 comments

What is the issue? Navigation on the Learn page of NucleoidJS doesn't work properly.

How to reproduce?

  • Goto the Learn page
  • Click on Express.js in the right-side navigation bar it doesn't scroll down to that section. Navigation doesn't work properly for all learning sections.

Gulshanaggarwal avatar May 20 '22 11:05 Gulshanaggarwal

@canmingir can I start working on the issue?

Gulshanaggarwal avatar May 20 '22 11:05 Gulshanaggarwal

πŸ‘ Sounds good, honestly, I couldn't find a good ToC library for React. BTW, HTML is generated thru markdown here

canmingir avatar May 20 '22 12:05 canmingir

@canmingir I have figured out why it's not working. If you clearly give a look at hyperlinks(on contents) that have either ? or , or .js included is not working.

Let's see through the image below - Here I removed ? from What is Nucleoid markdown and hyperlink is working now.

Screenshot (312)

Should I fix it by removing like this or something else? πŸ€”

Gulshanaggarwal avatar May 21 '22 08:05 Gulshanaggarwal

@canmingir what do you think about the previous comment ?

Gulshanaggarwal avatar May 22 '22 13:05 Gulshanaggarwal

Yes, you are right, the question mark is causing an issue in here. Instead of deleting an question mark from the content, let's see there is a workaround in react-markdown-heading, which I've opened up an issue on their side. BTW, I am in search of finding better ToC library as well, lmk if you know any of them,

https://github.com/kyoncy/react-markdown-heading/issues/33

canmingir avatar May 22 '22 18:05 canmingir

@canmingir I tried to generate the toc with another library react-toc but it has the same problem but one thing which I figured out is that organizations like socket.io or enarx uses docusaurus tool with markdown files to generate their website content including toc.

What do you think πŸ€”

Gulshanaggarwal avatar May 23 '22 11:05 Gulshanaggarwal

Fantastic, docusaurus is looking really cool, we can switch into that, instead of trying to maintain our markdown generator

canmingir avatar May 23 '22 14:05 canmingir

@canmingir So, what's the plan for switching? Do you have any idea so that we can start?

Gulshanaggarwal avatar May 23 '22 16:05 Gulshanaggarwal

I would say yes, let's switch, do you want to give a shot?

canmingir avatar May 23 '22 16:05 canmingir

@canmingir in open-source always! let's give it a shot. What's the plan?

Gulshanaggarwal avatar May 23 '22 17:05 Gulshanaggarwal

I've been looking at it, looks like it won't be easy switch over, but I think this gives better handling on our docs, I will be working on it, but it may take awhile tho

canmingir avatar May 24 '22 03:05 canmingir

@canmingir ok, then go ahead. Once you start I will join you.

Gulshanaggarwal avatar May 24 '22 05:05 Gulshanaggarwal

There is a conversation going on, docusaurus may not be possible with MUI

https://github.com/facebook/docusaurus/issues/7505

canmingir avatar May 26 '22 14:05 canmingir

@canmingir If MUI is not possible then we can go ahead with what docusaurus provides.

Gulshanaggarwal avatar May 26 '22 17:05 Gulshanaggarwal

Working on a hybrid solution, I am trying to keep the main page with MUI, but rebuilding rest of pages with docusaurus (They are already in markdown anyway). Let see, how far I can go with

https://github.com/NucleoidJS/nucleoid.com/tree/docusaurus

canmingir avatar May 26 '22 18:05 canmingir

πŸ‘

Gulshanaggarwal avatar May 27 '22 14:05 Gulshanaggarwal

Finally, docusaurus version:

https://nucleoid.com/docs/get-started/

canmingir avatar Jun 05 '22 03:06 canmingir

Improved UI great! although there are still problems.

Gulshanaggarwal avatar Jun 05 '22 08:06 Gulshanaggarwal

Hey Can, can you tell me if any help I can do?

Gulshanaggarwal avatar Jun 06 '22 15:06 Gulshanaggarwal