mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-23 17:05:26 +02:00
Code Issues Wiki Activity

Use relative path to documentation images folder for GitHub
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

Browse source
This commit is contained in:
John Dallaway 2024-11-07 12:20:08 +00:00
parent 171afed0b0
commit fb20d6cc9a
2 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/org.eclipse.cdt.doc.user/README.md Normal file
View file

@ -0,0 +1,13 @@
# 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](src/asciidoc/example.adoc).
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
```

2
doc/org.eclipse.cdt.doc.user/src/asciidoc/example.adoc
View file

@ -13,7 +13,7 @@ Contributors:
// support image rendering and table of contents within GitHub
ifdef::env-github[]
:imagesdir: https://raw.githubusercontent.com/eclipse-cdt/cdt/main/doc/org.eclipse.cdt.doc.user/images
:imagesdir: ../../images
:toc:
:toc-placement!:
endif::[]