tesseract-ocr / tessdoc

Tesseract documentation
https://tesseract-ocr.github.io/tessdoc/
1.84k stars 363 forks source link

Markdown version of FAQ which was in asciidoc format #1

Closed Shreeshrii closed 4 years ago

stweil commented 4 years ago

The FAQ.asciidoc file is still there (not only for FAQ, but also some more). Maybe it is possible to use those files with GitHub Pages, too. Would that be desirable, or is it better to replace all by markdown versions? Then the asciidoc version can be removed.

Shreeshrii commented 4 years ago

The FAQ.asciidoc file is still there (not only for FAQ, but also some more). Maybe it is possible to use those files with GitHub Pages, too. Would that be desirable, or is it better to replace all by markdown versions?

The FAQ was not showing up under tessdoc.

If asciidoc will work with Github pages, then we could leave them as is.

The absolute links will still need change.

Shreeshrii commented 4 years ago

@stweil I am closing this PR.

amitdo commented 4 years ago

https://github.com/asciidoctor/jekyll-asciidoc#publishing-your-site

So it seem we need to change the name.

Do the name changing in one commit, and later do the content update in a second commit. This is a good practice when working with git.

amitdo commented 4 years ago

Do the name changing in one commit, and later do the content update in a second commit.

I now see that you already did so, in another PR.

stweil commented 4 years ago

Yes, I also came to the conclusion that those asciidoc files have to be changed to markdown.

Currently I am struggling with tables which seem to work differently on GitHub pages: https://tesseract-ocr.github.io/tessdoc/Data-Files-Contributions.html.

amitdo commented 4 years ago

https://tesseract-ocr.github.io/tessdoc/Data-Files.html https://github.com/tesseract-ocr/tessdoc/blob/master/Data-Files.md

The tables here look fine.

stweil commented 4 years ago

Thanks. I could fix the bad one, too. |--| should have used at least three -.