1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-21 13:42:30 +02:00
cdt/doc/org.eclipse.cdt.doc.user/README.md
John Dallaway fb20d6cc9a
Some checks failed
License vetting status check / call-license-check (push) Failing after 0s
Build and Test / build (push) Failing after 5s
Code Cleanliness Checks / build (push) Failing after 3s
Use relative path to documentation images folder for GitHub
2024-11-07 21:16:23 +00:00

576 B

C/C++ Development User Guide

AsciiDoc content

The Asciidoctor Maven Plugin is configured to generate an HTML file in the html/ folder for each AsciiDoc source file (*.adoc) placed in the src/asciidoc/ folder.

All AsciiDoc source files should include GitHub rendering support, as illustrated in the example document.

During content development, HTML files may be generated by invoking Maven locally:

mvn --define jgit.dirtyWorkingTree-cdtDefault=ignore --projects org.eclipse.cdt:org.eclipse.cdt.doc.user generate-resources