Skip to content

Commit 86d35ea

Browse files
committed
Add live example to readme
1 parent 6fe8fe6 commit 86d35ea

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ jobs:
4747
4848
Once this workflow is executed, the `docs` directory with documentation will be added (or updated if necessary) to your repository. Optionally, you can set up GitHub Pages for your repository to have documentation available at yourname.github.io/yourmodule.
4949

50+
[Live documentation][live-example] and the [repository][example-repo] as an example how can this action be used.
51+
5052
It's worth noting that the action output depends on the V `doc` tool, so consider using a stable V version in your workflow (see the `v-version` input of `nocturlab/setup-vlang-action` action) to make sure generated documentation is consistent and has no issues (or they are known or minor).
5153

5254
### Inputs
@@ -62,3 +64,6 @@ It's worth noting that the action output depends on the V `doc` tool, so conside
6264
## License
6365

6466
Licensed under the [MIT License](./LICENSE.md).
67+
68+
[example-repo]: https://github.com/alexesprit/colors
69+
[live-example]: https://alexesprit.com/colors/

0 commit comments

Comments
 (0)