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

Upgrade to 9.x #75

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Upgrade to 9.x #75

wants to merge 19 commits into from

Conversation

Roiocam
Copy link

@Roiocam Roiocam commented Feb 26, 2024

Motivation

Try to fix apache/pekko#1097 and #70

Most of the migration has been completed, except some incompatible parts and new features

Feature

  • deprecated heroes
  • deprecated logo icon
  • Back-to-top button
  • Tooltips
  • Replace "edit this page"
  • Replace "versioning"
  • Better search
  • color schema: dark mode

Tasklist

  • Search
    • can not initialized
    • reset button position
  • Source icon position
  • Hero style: deprecated
  • font-awsome icon issue: Temporary repair
  • javascript complain 'lang' undefined
  • paradox-material-theme.js re-render navigation: Occasionally, when I open it, this kind of confusion occurs apache/pekko-site#63
  • TOC issue
  • Edit this page issue
  • Next navigator issue
  • Version missing
  • getting-started color button issue: mkdocs has same issue
  • add color schema feature: unsupport toggle

@Roiocam
Copy link
Author

Roiocam commented Feb 28, 2024

Hi @squidfunk, I noticed that you replied to us in the issue(apache/pekko#1097) before. I am currently working on upgrading MkDocs-Material to version 9.x. Most of the upgrade work (not fully supporting all features) has been completed, and there is only one search configuration import left. Can you take a look that how this part should be imported? Thank you very much

@Roiocam
Copy link
Author

Roiocam commented Feb 29, 2024

After using mkdocs static site to debug in the browser, it is found that these configurations are read in search_index.json

2. config is the parameter index$ of setupWorker 截屏2024-02-29 11 15 13
2. config is the parameter index$ of mountSearch 截屏2024-02-29 11 15 13
3. index$ is assigned by fetchSearchIndex function 截屏2024-02-29 11 22 13 截屏2024-02-29 11 22 20
4. fetchSearchIndex read from search_index.json 截屏2024-02-29 11 17 43 截屏2024-02-29 11 17 25

@squidfunk
Copy link

As much as I'd like to help you, I'm afraid I'm currently tight on time, so I'm not able to help out porting the search. Note that the search code is quite heavily documented, so I recommend reading the code and comments.

@Roiocam
Copy link
Author

Roiocam commented Feb 29, 2024

As much as I'd like to help you, I'm afraid I'm currently tight on time, so I'm not able to help out porting the search. Note that the search code is quite heavily documented, so I recommend reading the code and comments.

Thank you for your reply. These problems have been solved through debug.

@Roiocam Roiocam marked this pull request as ready for review February 29, 2024 04:32
@Roiocam Roiocam marked this pull request as draft February 29, 2024 05:13
@Roiocam Roiocam marked this pull request as ready for review February 29, 2024 09:01
@Roiocam
Copy link
Author

Roiocam commented Mar 1, 2024

PTAL @mdedetrich @mkurz

@mdedetrich
Copy link
Contributor

PTAL @mdedetrich @mkurz

It's a big PR, will take a look next week when I have more time

@mkurz
Copy link
Member

mkurz commented Mar 8, 2024

I am very low on time so I will not look into this PR anytime soon... leaving it to @mdedetrich if you have more time...

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.

super-high cost when searching for documents
4 participants