LibreLingo icon indicating copy to clipboard operation
LibreLingo copied to clipboard

Converted all markdown files in doc dir into asciidoc format

Open ciampix opened this issue 4 years ago • 6 comments

Converted all documentation files present in the docs directory from markdown format into asciidoc format for improving future maintenance.

ciampix avatar Aug 08 '21 00:08 ciampix

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/kantord/libre-lingo/7bWc9BbfdyPcr1QL83FUCm1Hg9z7
✅ Preview: Failed

[Deployment for 0d277b2 failed]

vercel[bot] avatar Aug 08 '21 00:08 vercel[bot]

Hi @ciampix ! 👋

Thanks. I created a pull request in your fork with some updates: https://github.com/ciampix/LibreLingo/pull/1

This installs antora and partially fixes the file structure so that it works, however several things are broken.

You can try it by running

yarn install - to update the dependencies, since I installed some new ones yarn workspace docs start - this should start a local server of the documentation site. Careful, because it does not update automatically, so if you make changes, you need to restart the server each time.

Or you can simply run yarn workspace docs build to build the latest version of the docs site, and open it in your browsers.

This should be enough to demo what antora is capable of. Based on the antora documentation, you should be able to fix the rest of the files and navigation & structure things properly.

kantord avatar Aug 09 '21 20:08 kantord

I finally made it to enable mermaid flowchart. There is a bug in the asciidoctor-kroki library that prevents the flowchart to be click-able unless you open it (the single image) in a different browser window. Hope that they fix it soon... Now I can see to the rest of main page that is still to the default.

ciampix avatar Sep 07 '21 06:09 ciampix

I finally made it to enable mermaid flowchart. There is a bug in the asciidoctor-kroki library that prevents the flowchart to be click-able unless you open it (the single image) in a different browser window. Hope that they fix it soon... Now I can see to the rest of main page that is still to the default.

amazing! do you have an issue to track that in asciidoctor-kroki?

btws, I think there has been new documentation merged to main since this PR was started. Will you be able re-generate the files? If not, I can figure it out for you what the exact changes were and we can add it manually

kantord avatar Sep 08 '21 20:09 kantord

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar Sep 13 '21 11:09 sonarqubecloud[bot]

Hi @ciampix !

do you have any news on this? Can I help you somehow now?

kantord avatar Dec 29 '21 20:12 kantord

You sadly did well 'cause I do have not enough time to follow this and it seems pretty unuseful or not that much useful anyway since md is very similar to asciidoc.

ciampix avatar Apr 25 '23 23:04 ciampix