Skip to content

Commit

Permalink
Use relative path to documentation images folder for GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
jld01 committed Nov 7, 2024
1 parent 171afed commit fb20d6c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions doc/org.eclipse.cdt.doc.user/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion doc/org.eclipse.cdt.doc.user/src/asciidoc/example.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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::[]
Expand Down

0 comments on commit fb20d6c

Please sign in to comment.