Convert the doc format from XDOC to Markdown

[awxiaoxian2020]

Now, .md is more popular in GitHub. And some mybatis projects use it.
I think we can do something with it.

[xgl835]

study follow you,thank you!

[awxiaoxian2020]

@harawata I want to know whether the issue is valid or not. I want to work on it.

[harawata]

Hello @awxiaoxian2020 ,

The obvious downside of the format change is that pull requests that contain doc changes require rework.
And there is an open PR #2586 which may require a lot of rework (we may not be able to merge it anytime soon).

Another possible/less-obvious downside is the review cost.
You may not know the answer to this, but when we compare the HTML files generated from .xdoc and .md using a diff tool, do they look the same?
If they look the same, it is fine, but if there are many differences, it will be a time consuming task to review the patch.

Also, this issue does not get any upvote so far.

So...
Although I personally prefer markdown over xdoc, I'm not sure if it's worth our time and effort (including yours) to convert the perfectly working .xdoc files, at this point.

[awxiaoxian2020]

Hello @awxiaoxian2020 ,

The obvious downside of the format change is that pull requests that contain doc changes require rework. And there is an open PR #2586 which may require a lot of rework (we may not be able to merge it anytime soon).

Another possible/less-obvious downside is the review cost. You may not know the answer to this, but when we compare the HTML files generated from .xdoc and .md using a diff tool, do they look the same? If they look the same, it is fine, but if there are many differences, it will be a time consuming task to review the patch.

Also, this issue does not get any upvote so far.

So... Although I personally prefer markdown over xdoc, I'm not sure if it's worth our time and effort (including yours) to convert the perfectly working .xdoc files, at this point.

Sorry for late reply.

I will just change the style rather than the content. So I think it's not a problem for review. And we can work on this in a long period.

As the format of the document is more for developers than users, this issue has not received an upvote. So as long as you are willing to see the markdown format, I am willing to work on it.

#2586 I can also rework.

[harawata]

@awxiaoxian2020 ,

Okay.
As a trial run, could you convert just one file and send a PR?
Any file other than index.xml is fine.

It's not urgent, so please take your time.

Thank you!

[awxiaoxian2020]

I will use https://github.com/awxiaoxian2020/html-markdown-util-for-mybatis-docs to get an init version. This will help
efficiency and accuracy :)