Update on MkDocs Fork and Ecosystem Continuity

[DevTwilight]

Update on MkDocs Fork and Ecosystem Continuity

Hi @jaywhj,

Just to keep you updated on the MkDocs ecosystem: the original MkDocs project is moving forward with “Version 2,” but this has left the community in a situation where a fork and rename are being planned to continue supporting the existing ecosystem.

The fork aims to maintain compatibility with existing plugins and themes, and strategies like meta-importers are being explored to allow current extensions to work without major modifications. This should help reduce fragmentation and keep the ecosystem functional while Version 2 evolves.

More context and discussion about the fork can be found here: MkDocs Community Discussion

Thought this might be useful context for MaterialX and other projects that rely on MkDocs.

[jaywhj]

@DevTwilight

Alright, thanks for the reminder.

I’ve been keeping an eye on the discussions in our community and have read all of them, just haven’t had time to reply yet. ^_^

MaterialX already prepared for this in advance. The update released a few days ago has restricted the dependent version of mkdocs to < 2 to ensure stability first.

Then, going forward, I’ll wait for updates from the mkdocs community. I fully support whatever direction they take, whether it’s a fork or a rename!

[joapuiib]

Our continuation of MkDocs and a warning regarding "MkDocs 2.0" #33 - https://github.com/orgs/ProperDocs/discussions/33

[DevTwilight]

we should use GitHub action for deployment of material docs

[DevTwilight]

i know

[jaywhj]

@DevTwilight

Sorry for the late response. I meant the official MaterialX docs. We can design a better GitHub Actions workflow, shift to ProperDocs, and avoid using gh-pages in all your projects as well.

This workflow for MaterialX has always existed and works fine. It’s just that I personally prefer using gh-deploy, so I haven’t touched it. I’ll switch to the workflow method in the next version and add support for ProperDocs.

If you want to use this workflow, simply remove the disabled suffix from this file:
.github/workflows/documentation.yml.disabled

[DevTwilight]

i think u are confused i was suggesting u to use the workflow

[DevTwilight]

ProperDocs already switched to a GitHub Action without gh-deploy command: https://github.com/ProperDocs/properdocs/blob/master/.github/workflows/deploy-docs.yml

just do let me know when u are planing because i am willing to do this

[jaywhj]

ProperDocs already switched to a GitHub Action without gh-deploy command: https://github.com/ProperDocs/properdocs/blob/master/.github/workflows/deploy-docs.yml

just do let me know when u are planing because i am willing to do this

This weekend.

I'll be releasing a new version this weekend.