Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigation problem #17

Open
Gulshanaggarwal opened this issue May 20, 2022 · 19 comments
Open

Navigation problem #17

Gulshanaggarwal opened this issue May 20, 2022 · 19 comments

Comments

@Gulshanaggarwal
Copy link

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
Copy link
Author

@canmingir can I start working on the issue?

@canmingir
Copy link
Member

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

@Gulshanaggarwal
Copy link
Author

@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
Copy link
Author

@canmingir what do you think about the previous comment ?

@canmingir
Copy link
Member

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,

kyoncy/react-markdown-heading#33

@Gulshanaggarwal
Copy link
Author

@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 🤔

@canmingir
Copy link
Member

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

@Gulshanaggarwal
Copy link
Author

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

@canmingir
Copy link
Member

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

@Gulshanaggarwal
Copy link
Author

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

@canmingir
Copy link
Member

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

@Gulshanaggarwal
Copy link
Author

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

@canmingir
Copy link
Member

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

facebook/docusaurus#7505

@Gulshanaggarwal
Copy link
Author

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

@canmingir
Copy link
Member

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

@Gulshanaggarwal
Copy link
Author

👍

@canmingir
Copy link
Member

canmingir commented Jun 5, 2022

Finally, docusaurus version:

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

@Gulshanaggarwal
Copy link
Author

Improved UI great! although there are still problems.

@Gulshanaggarwal
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants