Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • 11:56
    krahu commented #2937
  • 10:20
    squidfunk labeled #4689
  • 10:10
    mh166 opened #4689
  • 09:25
    joskfg commented #4686
  • 09:22
    joskfg commented #4686
  • 08:54
    squidfunk labeled #4686
  • 08:54
    squidfunk unlabeled #4686
  • 08:54
    squidfunk commented #4686
  • Nov 28 18:02
    squidfunk labeled #4686
  • Nov 28 17:52
    facelessuser commented #4686
  • Nov 28 15:43

    github-actions[bot] on gh-pages

    Deployed 39124f991 with MkDocs … (compare)

  • Nov 28 14:53
    joskfg opened #4686
  • Nov 28 12:38
    wilhelmer commented #4683
  • Nov 28 12:37

    github-actions[bot] on gh-pages

    Deployed 39124f991 with MkDocs … (compare)

  • Nov 28 12:36
    squidfunk labeled #4683
  • Nov 28 12:36
    squidfunk commented #4683
  • Nov 28 12:36
    squidfunk closed #4683
  • Nov 28 12:36

    squidfunk on master

    Documentation (compare)

  • Nov 28 12:35

    github-actions[bot] on gh-pages

    Deployed 8748c71df with MkDocs … (compare)

  • Nov 28 12:34

    squidfunk on master

    Updated Insiders changelog (compare)

Note that this is not based on React or some other SPA framework since we're doing progressive enhancement. The whole workflow is based on RxJS, which is a great fit for enhancing static sites.
Thus, write your component as plain JavaScript and then mount it with RxJS. You can easily hook into instant loading and Material for MkDocs features.
I might write a blog article explaining how to mount custom stuff in the future.
Jason Li
@zeshengli
Really appreciate the detailed explanation!
Martin Donath
@squidfunk
8.3.0 is out, including the features from the funding goal we just reached! Many thanks to all sponsors for making this possible and allowing me to work on this project! ❤️
Arthri
@Arthri
where can I add a license for the wiki? is there somewhere I can place a CC button?
Arthri
@Arthri
2022.06.03 13.00.02.462.png
on an unrelated note, I found a small search bug where content tabs display like this in search
C and C++ become CC++
Martin Donath
@squidfunk
@Arthri I'm not sure what you mean by Wiki, but you can place a button anywhere in a Markdown file. For other locations on the page you'd need to extent the theme.
Arthri
@Arthri
I see, thanks
Some wikis(especially MediaWiki) https://www.mediawiki.org/wiki/MediaWiki have a notice they're under a CC license, and they're usually at the bottom of every page. Is there a equivalent for MkDocs/Material?
Arthri
@Arthri
thanks again
Timo Toups
@lampensau
love the new anchor links :heart_eyes:
Martin Donath
@squidfunk
Hehe, thanks! I also think they turned out pretty great
Blueswen
@Blueswen
@squidfunk , the Chinese searching bug fixed in squidfunk/mkdocs-material-insiders@95aea95 is really awesome. I think this could also help those language need composition like Japanese. Thanks again.
Martin Donath
@squidfunk
Perfect, glad to hear! As we intercept the composition(start|end) events, it should be fixed for Japanese and all languages using composition as well.
Blueswen
@Blueswen
@squidfunk I also found another Chinese searching highlighting bug. If target query string is behind other Chinese text, searching highlighting mark does not show up. I think it's because match expression in highlighter/index.ts can not deal with this scenario. I am not good at regex, but I found it could solved by adding another | in first group of expression (replace (^|${config.separator}|\\b) with (^|${config.separator}|\\b|)). Though it seems to work, I am not sure that could cause any side effect or not. Maybe you can fix this with a better way ?
image.png
With query parameter h=公司, but searching highlighting is not working
image.png
With query parameter h=公司 then modify match expression first group to (^|${config.separator}|\\b|), and searching highlighting is working fine.
Blueswen
@Blueswen
Should I open an issue to discuss this bug?
Martin Donath
@squidfunk
I guess it's related to word boundaries. Yes, you can open an issue. I'll wanted to revisit search highlighting at some point anyway, but this might take longer because my next weeks are pretty packed.
In essence, search highlighting should be based on the tokens we have in the index anyways, but it's currently still implemented as a regex.
Blueswen
@Blueswen
I guess it's related to word boundaries. Yes, you can open an issue. I'll wanted to revisit search highlighting at some point anyway, but this might take longer because my next weeks are pretty packed.
It's not a big problem, take your time. Thanks for your hard work these days.

In essence, search highlighting should be based on the tokens we have in the index anyways, but it's currently still implemented as a regex.

I think maybe regex is the only way to implement search highlighting. Because it's hard to map those tokens back to their original string position in Chinese.

Jordan Halterman
@kuujo
Hi. I’m having trouble enabling. Avigayio
Ugh… I’m having trouble enabling navigation tabs. Here’s an example MkDocs configuration that’s showing the problem: https://github.com/atomix/docs/blob/master/mkdocs.yml#L40 I can see that the search features are enabled, so it’s not a syntax error. But for some reason I cannot see any tabs on top of the page when navigation.tabs is enabled. What am I missing?
Martin Donath
@squidfunk
I'm not sure what you're doing with the !import statement in nav. In general, navigation tabs are the first level of nesting, see https://github.com/squidfunk/mkdocs-material/blob/08f38332448fa954a44c0bf42e2e3f423d865912/mkdocs.yml#L164-L228, i.e. Home, Getting started, Setup, Reference, Insiders and Blog
If you define your nav structure this way, navigation tabs should work as advertised.
Jordan Halterman
@kuujo
@squidfunk that’s just syntax supported by the multirepo pkygin
But FTR I have tried it with various nested “nav” structures of various depths and disabled the multirepo plugin, and nothing has worked.
Martin Donath
@squidfunk
That is very weird. Navigation tabs have been there for so long, it's very likely a config error, but I'm not seeing it either. If you can provide a minimal reproducible example, please open an issue so I can look into it.
bradumbaugh
@bradumbaugh_twitter
Martin, just FYI — I don’t see those new date icons you mentioned on Twitter yesterday. Not a big deal obviously… just went to admire your handiwork, and it looks like maybe they didn’t get deployed?
Martin Donath
@squidfunk
@bradumbaugh_twitter thanks for noting! They're only added to the 3-4 latest Insiders features, e.g. https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips
It's just to bring the reader's attention to "this is brand new"
Jordan Halterman
@kuujo
@squidfunk I think it was something with my machine. After I updated updated Mac OS, it worker exactly as expected. I suspect it just needed that restart to reset the environment or something.
I guess if someone sees this again, you might suggest they do something similar.
For reference, I had just installed Python/pip with Homebrew and used it to install MkDocs and the Material theme. 🤷‍♂️
Also I was testing it in Chrome
Martin Donath
@squidfunk
Thanks for coming back. Homebrew is definitely not a good idea to install MkDocs or Material for MkDocs with – packages are very likely out-of-date. The recommendation is to use pip or docker
Jordan Halterman
@kuujo
Sorry I worded that pretty vaguely. I used Homebrew to install Python3/pip, and pip to install mkdocs and the theme.
Benoît Delaup
@bdelaup_gitlab
Dear @squidfunk, thanks for this project. As a teacher I started to use mkdocs for my courses successfully. The only caveat for my use case is the lack of efficient pdf export solution. All mkdocs plugins I went through are not well working enough for simple daily instant exports. I was wondering if you have any plan for a clean intégration of a pdf generator for mkdocs inside Material.
Martin Donath
@squidfunk
Thanks, I'm glad it works so well for you. I understand your troubles, and I'll see what I can do, but I think "printing websites" is a hard problem. I'd be curious to learn what you specifically disliked about the existing solutions and invite you to create a discussion with your findings evaluating different solutions with their advantages and shortcomings.