digama0 / mmj2

mmj2 GUI Proof Assistant for the Metamath project
GNU General Public License v2.0
72 stars 24 forks source link

change the first level html to markdown #60

Open mountain opened 2 years ago

mountain commented 2 years ago

Since markdown is widely used, and github support markdown well but html badly, so let's change the html files in first level directory to markdown.

About htmls in doc directory, I currently just hold on, because these htmls could be integrated with the IDE in the future.

mountain commented 2 years ago

in issue #39 , people are also complain about html, maybe we need consider change all html to markdown? there are pandoc tool can convert them automatically. But I am not sure about this. These htmls could be integrated as manual with the IDE in the future.

digama0 commented 2 years ago

I wouldn't mind having all the html files in the doc/ folder converted to markdown. I certainly have no plans to incorporate an HTML viewer in mmj2, that sounds like something we should certainly outsource to an actual browser. If you want to add a help menu, it can just open the markdown docs in github by calling the default browser.

digama0 commented 2 years ago

Not sure about the LicenseEnclosure.java move. Java files can't usually just be moved around, did you update references to it?

mountain commented 2 years ago

After a search, I only found LicenseEnclosure.java was referenced in the CHGLOG.TXT which record its changes in past revisions. So CHGLOG.TXT should not be modified, otherwise I don't found any usage in the project.

mountain commented 2 years ago

OK, I will consider change all html to markdown.