Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AnranW committed Jan 12, 2024
1 parent 58cfb71 commit 24e8634
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Intro
This is AwesomeAnranSlides, built upon [Animotion](https://animotion.pages.dev).
This is **AwesomeAnranSlides**, built upon [Animotion](https://animotion.pages.dev).
A preview can be found [here](https://AnranW.github.io/AwesomeAnranSlides).

# Features
- Automatically calculated total slide number.
![public/pagenumber.png]
![[public/pagenumber.png]]
- Automatically generated navigation bar on top, including separation into chapters.
![public/navibar.png]
![[public/navibar.png]]
- Highligt current slide in navigation bar.
![public/highlight.png]
![[public/highlight.png]]
- Hyperlink to corresponding slides.
![public/goto.png]
![[public/goto.png]]

Note that this project is still under development, bugs can exist and features can change.

# Technical details
The most important modifications are in the following files:
- src/layout.svelte : define the layout
- src/slides.svelte : includes the scripts that implements the features
- src/config.ts : activate custom layout, etc.
- [src/layout.svelte](src/layout.svelte) : define the layout
- [src/slides.svelte](src/slides.svelte) : includes the scripts that implements the features
- [src/config.ts](src/config.ts) : activate custom layout, etc.

# Setup, usage, and deployment
## Setup
Expand Down Expand Up @@ -51,9 +51,9 @@ Use layout inside <Slide>.
</Layout>
```

Declare a new chapter.
Declare a new chapter with chapter name.
```html
<script>newChapter("Introduction")</script>
<script>newChapter("Chapter Name")</script>
```

## Deployment
Expand Down

0 comments on commit 24e8634

Please sign in to comment.