Convert the doc format from XDOC to Markdown
See original GitHub issueNow, .md
is more popular in GitHub. And some mybatis projects use it.
I think we can do something with it.
Issue Analytics
- State:
- Created a year ago
- Comments:5 (4 by maintainers)
Top Results From Across the Web
Convert MS Word Document to Markdown Format
You can convert the MS Word file (.docx or .doc) to markdown format easily. Markdown is an easy syntax that you can apply...
Read more >ms office - How can doc/docx files be converted to markdown ...
Pandoc supports conversion from docx to markdown directly: pandoc -f docx -t markdown foo.docx -o foo.markdown. Several markdown formats are supported:
Read more >Word to Markdown Converter
Convert Word or Google documents to Markdown online. ... Converting a Word (or Google) Document is as easy as 1, 2, 3... Step...
Read more >Convert DOCX to Markdown Online - Aspose Products
1. Upload DOCX files to convert them to MD format online. 2. Specify DOCX to MD conversion options. 3. Click the button to...
Read more >How to Easily Convert Word to Markdown with Pandoc - Medium
The easiest way to convert a Word document to a Markdown file is with the -f (FORMAT) flag. This is the file format...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@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!
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.