search

making / yavi

Yet Another Validation for Java (A lambda based type safe validation framework)
https://yavi.ik.am
Apache License 2.0
744 stars 61 forks source link

MkDocs material #343

Open lasteris opened 1 year ago

lasteris commented 1 year ago

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 commented 1 year ago

What is the motivation or background?

lasteris commented 1 year ago

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 commented 1 year ago

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...