-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: ✏️ add a README to examples folder with recorded demos
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Examples | ||
|
||
This folder contains examples you can use as a reference for writing your own slides. | ||
Sometimes, these examples can be out-of-sync with the latest kittik implementation, but I’m trying to run these as well from time to time to check that everything is working. | ||
If something didn’t work out for you, please open an issue and I will assist you with everything I can. | ||
|
||
- [Examples](#examples) | ||
- [Animate a shape](#animate-a-shape) | ||
- [Create a deck with several slides](#create-a-deck-with-several-slides) | ||
- [Draw an ASCII art in the slide](#draw-an-ascii-art-in-the-slide) | ||
- [Hello, World in Kittik](#hello-world-in-kittik) | ||
- [Customize options for shape or animations](#customize-options-for-shape-or-animations) | ||
- [Create shapes or animations once and reuse it across deck](#create-shapes-or-animations-once-and-reuse-it-across-deck) | ||
|
||
## Animate a shape | ||
|
||
| Source | Demo | | ||
| ---------------------- | ----------------------------- | | ||
| [Link](./animation.ts) | ![animation.ts][animation.ts] | | ||
|
||
## Create a deck with several slides | ||
|
||
| Source | Demo | | ||
| ----------------------- | ------------------------------- | | ||
| [Link](./few-slides.ts) | ![few-slides.ts][few-slides.ts] | | ||
|
||
## Draw an ASCII art in the slide | ||
|
||
| Source | Demo | | ||
| ------------------- | ----------------------- | | ||
| [Link](./figlet.ts) | ![figlet.ts][figlet.ts] | | ||
|
||
## Hello, World in Kittik | ||
|
||
| Source | Demo | | ||
| ------------------------ | --------------------------------- | | ||
| [Link](./hello-world.ts) | ![hello-world.ts][hello-world.ts] | | ||
|
||
## Customize options for shape or animations | ||
|
||
| Source | Demo | | ||
| -------------------------- | ------------------------------------- | | ||
| [Link](./shape-options.ts) | ![shape-options.ts][shape-options.ts] | | ||
|
||
## Create shapes or animations once and reuse it across deck | ||
|
||
| Source | Demo | | ||
| ------------------- | ----------------------- | | ||
| [Link](./shared.ts) | ![shared.ts][shared.ts] | | ||
|
||
[animation.ts]: https://user-images.githubusercontent.com/3625244/84570127-e4e17500-ad93-11ea-9a56-18bf0bca8366.gif | ||
[few-slides.ts]: https://user-images.githubusercontent.com/3625244/84570300-481fd700-ad95-11ea-938a-6113af611345.gif | ||
[figlet.ts]: https://user-images.githubusercontent.com/3625244/84570384-ea3fbf00-ad95-11ea-8c1c-4aca3f2a590c.gif | ||
[hello-world.ts]: https://user-images.githubusercontent.com/3625244/84570438-2ecb5a80-ad96-11ea-8099-11b9fa87e6a7.gif | ||
[shape-options.ts]: https://user-images.githubusercontent.com/3625244/84570597-20ca0980-ad97-11ea-9eae-16f37966a3d1.gif | ||
[shared.ts]: https://user-images.githubusercontent.com/3625244/84570672-9fbf4200-ad97-11ea-9135-cde31db14325.gif |