Skip to content

Commit

Permalink
docs: refactor examples
Browse files Browse the repository at this point in the history
  • Loading branch information
lihbr committed Jan 15, 2023
1 parent 1e5a91b commit ab798c8
Show file tree
Hide file tree
Showing 31 changed files with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions docs/content/examples.md
Expand Up @@ -6,43 +6,49 @@ title: Examples

Here are some examples showcasing what Akte enables.

:::callout{icon=👋 title="Basic" level=2}
## Common

:::callout{icon=👋 title="Basic" level=3}
This example shows basic usage of Akte with JavaScript or TypeScript. When executed, an Akte config behaves as a minimal CLI. This is helpful for simple use cases.

<br />

[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/basic)
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/common/basic)
:::

:::callout{icon= title="Catch all" level=2}
:::callout{icon= title="Catch all" level=3}
This example shows usage of catch all routes. This is helpful for rendering similar files that aren't living under the same hierachy.

<br />

[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/catch-all)
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/common/catch-all)
:::

:::callout{icon=🆔 title="Non-HTML" level=2}
:::callout{icon=🆔 title="Non-HTML" level=3}
This example shows usage of Akte to render non-HTML files. This is helpful for rendering any kind of asset, XML, JSON, etc.

<br />

[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/non-html)
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/common/non-html)
:::

:::callout{icon=🎹 title="Programmatic" level=2}
This example shows programmatic usage of Akte. This is helpful for running Akte in various environments, including serverless.
## Vite

:::callout{icon= title="Basic" level=3}
This example shows usage of Akte as a [Vite](https://vitejs.dev) plugin. This is helpful for processing assets of any sort as well as taking advantage of Vite great developer experience while developing.

<br />

[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/programmatic)
[Open in Stackblitz ›](https://stackblitz.com/github/lihbr/akte/tree/master/examples/vite/basic?file=files%2Findex.ts&theme=dark)<br />
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/vite/basic)
:::

:::callout{icon= title="Vite" level=2}
This example shows usage of Akte as a [Vite][https://vitejs.dev] plugin. This is helpful for processing assets of any sort as well as taking advantage of Vite great developer experience while developing.
## Programmatic

:::callout{icon=🎹 title="Basic" level=3}
This example shows programmatic usage of Akte. This is helpful for running Akte in various environments, including serverless.

<br />

[Open in Stackblitz ›](https://stackblitz.com/github/lihbr/akte/tree/master/examples/vite?file=files%2Findex.ts&theme=dark)<br />
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/vite)
[Check it out on GitHub ›](https://github.com/lihbr/akte/tree/master/examples/programmatic/basic)
:::
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit ab798c8

Please sign in to comment.