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

feat: Prefix sidebar items with module name (optional) #219

Merged

Conversation

javalsai
Copy link
Contributor

@javalsai javalsai commented Jun 5, 2023

Pull Request Template

Description

Creates an option (prefixModuleToSidebarItems_experimental) to add prefixes to sidebar items with their module name.

Resolves #218

Type of change

Please mark options that is/are relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Other (if so, then explain below briefly)

More

I don't know how this would behave with sorting as I have it disabled, so I thin it should be tested before merging.

VSCode automatically removed some extra spaces, I hope you're ok with that.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's Amazing! Thanks for creating your first PR for clean-jsdoc-theme. Someone will review it soon!

@javalsai javalsai force-pushed the experimental-sidebar-prettify branch from 151f254 to aaeacbc Compare June 5, 2023 18:44
@javalsai
Copy link
Contributor Author

javalsai commented Jun 5, 2023

I tried to sign the commits because I had the ssh keys bad configured and had to force push, but apparently I haven't fixed it :(

@javalsai javalsai force-pushed the experimental-sidebar-prettify branch 2 times, most recently from 1a66c75 to 470794b Compare June 5, 2023 18:57
Signed-off-by: javalsai <jvssxxi@gmail.com>
Signed-off-by: javalsai <jvssxxi@gmail.com>
@javalsai javalsai force-pushed the experimental-sidebar-prettify branch from 470794b to 42cb96a Compare June 5, 2023 19:22
@javalsai
Copy link
Contributor Author

javalsai commented Jun 6, 2023

Also I would like to know if you would be interested in syncing the theme (and font too) between tabs like in the video below. I can try to implement it easily this weekend.

theme-sync.mp4

@ankitskvmdam
Copy link
Owner

ankitskvmdam commented Jun 7, 2023

About this PR, I will try to test it as soon as possible, probably over the weekends.

Also I would like to know if you would be interested in syncing the theme (and font too) between tabs like in the video below. I can try to implement it easily this weekend.

Totally. Feel free to suggest as many improvements/ideas as you can.

@javalsai
Copy link
Contributor Author

javalsai commented Jun 8, 2023

@ankitskvmdam

I figured out how to include and build the code faster than I expected and already finished the tabs syncing feature, opened a PR #220 for it based off the changes on this one.

I don't think that needs documentation, but people can take advantage of it and integrate the syncing with their own website, like I do, if the generated docs are included in it, I leave it up to you.

@ankitskvmdam
Copy link
Owner

@javalsai Could you please add a test .js file so that I can test this feature. You can add one in demo/src directory.

@javalsai
Copy link
Contributor Author

@javalsai Could you please add a test .js file so that I can test this feature. You can add one in demo/src directory.

just did it

@ankitskvmdam ankitskvmdam merged commit 1008216 into ankitskvmdam:master Jun 12, 2023
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

Successfully merging this pull request may close these issues.

enhancement(forked): option for prefixing classes with their module
2 participants