Skip to content

Commit 55730ba

Browse files
author
Ondrej Machala
committed
docs: add links to working examples in integration docs
1 parent 675edeb commit 55730ba

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

docs/docs/integrations/docusaurus.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Docusaurus
22

3+
> Want to see it working? Check out the [full example on GitHub](https://github.com/omachala/heroshot/tree/main/integrations/examples/docusaurus) - a minimal setup you can clone and run.
4+
35
[Docusaurus](https://docusaurus.io/) is Meta's documentation framework, and it's everywhere in the open source world. If you're using it, you probably already know it's React-based and uses MDX - which gives you some nice options for displaying screenshots.
46

57
## The Magic: One Component, All Variants

docs/docs/integrations/mkdocs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MkDocs
22

3+
> Want to see it working? Check out the [full example on GitHub](https://github.com/omachala/heroshot/tree/main/integrations/examples/mkdocs) - a minimal setup you can clone and run.
4+
35
[MkDocs](https://www.mkdocs.org/) is huge in the Python world. If you're documenting a Python project, chances are you're using MkDocs - probably with the [Material theme](https://squidfunk.github.io/mkdocs-material/) which is fantastic.
46

57
## The Magic: One Macro, All Variants

docs/docs/integrations/vitepress.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# VitePress
22

3+
> Want to see it working? Check out the [full example on GitHub](https://github.com/omachala/heroshot/tree/main/integrations/examples/vitepress) - a minimal setup you can clone and run.
4+
35
[VitePress](https://vitepress.dev/) is what I use for this very documentation site, so it's the integration I know best. If you're using VitePress, you're in good company - it's a great choice for docs.
46

57
## The Magic: One Component, All Variants

0 commit comments

Comments
 (0)