eduardocopat / abap-docs

Enhanced ABAP documentation
https://eduardocopat.github.io/abap-docs/
MIT License
31 stars 5 forks source link

html tags in the markdown files #2

Open lwfl opened 2 years ago

lwfl commented 2 years ago

Thank you for a very useful project! I wanted to add more help on version 7.55 and re-generate the markdown files. Downloaded help 7.31, 7.40, 7.52 and 7.55. Added version 7.55 everywhere in the script files. I edited the build.sh file and left only this tsc && ts-node index.ts Now if I open an md file in Typora, I see some html tags

изображение

eduardocopat commented 2 years ago

Hi @lwfl,

Thanks for contributing with this issue. It could be that the HTML for the 7.55 documentation is slightly different from the other versions.

What happens if you open this file in a browser? Does it also show the HTML tags? This issue could be specific to Typora.

Nevertheless, feel free to contribute with a Pull Request (I am not actively looking at this project any more, but would review and test a PR).

Most likely, you would need to change the [parser](https://github.com/EduardoCopat/abap-docs/blob/master/src/parser.ts) to handle the special cases.

lwfl commented 2 years ago

Eduardo, thanks for the quick response. html tags can be seen in the markdown file itself. Probably, they changed the structure of html file and parser works incorrectly. Unfortunately, I don't have enough knowledge in TypeScript to join your project and make changes. I had an idea to make a converter from SapScript to markdown format. Similar to how ABAP_DOCU_DOWNLOAD_FILES report unloads help in html. The structure of SapScript is simpler than that of html.

изображение