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

MkDocs material #343

Open
lasteris opened this issue Sep 4, 2023 · 3 comments
Open

MkDocs material #343

lasteris opened this issue Sep 4, 2023 · 3 comments

Comments

@lasteris
Copy link

lasteris commented Sep 4, 2023

Hi @making, i am using your toolkit with great please, thank you for such wonderful lib.
I wonder, if i can contribute...
Can i rewrite your docs, which located https://yavi.ik.am/ to https://squidfunk.github.io/mkdocs-material/ ?
You can see how does it look HERE, and HERE as example.

@making
Copy link
Owner

making commented Sep 5, 2023

What is the motivation or background?

@lasteris
Copy link
Author

lasteris commented Sep 5, 2023

What is the motivation or background?

I am 4+ Java backend developer.
2 years ago I started looking at various static engines for internal company documentation. I discovered mkdocs material. nice looking, lots of built-in features: search, syntax highlighting, multi-versioning, multi-language, mobile responsive design, integration with GitHub pages, actively maintaining and many awesome plugins.

as opensource project i did just one for now:
https://eightm.github.io/JavaBackendStartGuide/

That's local Russian resource for people, who want to start learn java, to give them proper roadmap.

And, i want keep your docs actual version. You site for now stands by 0.9.1, but repo says version higher.

Maybe i should do PR and you will see ?

@making
Copy link
Owner

making commented Sep 5, 2023

I'm not sure if i would accept it, but if you want to do it, the master documentation is here
https://github.com/making/yavi-doc

Yeah, I don't have much bandwidth to update the doc...

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

No branches or pull requests

2 participants