Skip to content

Commit

Permalink
./gradlew :spotlessApply
Browse files Browse the repository at this point in the history
  • Loading branch information
mskopp committed Apr 17, 2024
1 parent 7fdec1c commit 4a2ad76
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,23 +81,24 @@ Check the repository workflow `Actions`. There should be an action publishing th
### More complex scenarios

- More complex scenarios than just supporting markdown from one `docs` folder is possible,
but not (yet) supported by github-pages-build.
but not (yet) supported by github-pages-build.
- In theory every other complex scenarios can be covered by building an `pages.yml` based
upon `pages-generate-from-docs-dir.yml` with individial enhancements.
upon `pages-generate-from-docs-dir.yml` with individial enhancements.
- Another typical case is to copy some resources from underneath the `src` repository folder
into a subfolder of `docs/` and referring it from `.md` files.
Especially for this scenario it is possible to provide a from-folder-path and
a to-folder-path.
Currently, 2 sets are supported (`from1` and `to1`, `from2` and `to2`). This repository
itself demonstrates how it works by the following usage. Another common combination example is
`from1: src/main/resources/schemas` and `to1: schemas` and the `.md` file using links to
`schemas/some-filename.xsd`.
into a subfolder of `docs/` and referring it from `.md` files.
Especially for this scenario it is possible to provide a from-folder-path and
a to-folder-path.
Currently, 2 sets are supported (`from1` and `to1`, `from2` and `to2`). This repository
itself demonstrates how it works by the following usage. Another common combination example is
`from1: src/main/resources/schemas` and `to1: schemas` and the `.md` file using links to
`schemas/some-filename.xsd`.

### Example

This repository also acts as an example, see `docs/index.md` and result on https://riege.github.io/github-pages-build

This repository uses `from1` and `to1` for demonstration purpose:

```
jobs:
pages:
Expand Down

0 comments on commit 4a2ad76

Please sign in to comment.