Skip to content

Commit

Permalink
Add example pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
alexkiro committed Nov 14, 2024
1 parent 2ae8269 commit 0748f85
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ deploying it to GitHub pages.
1. Click on "Use this template" in the top right to generate a new repo for your flipbook
2. After the new repo is created, go to Settings -> Pages
3. Change the "Source" option from "Build from branch" to "GitHub Actions"
4. Upload you pdf to repository
4. Upload your PDF to the repository, optionally removing/replacing the existing
"book.pdf" one.
5. Edit [.github/workflows/deploy.yml](.github/workflows/deploy.yml) file and change
the following options as needed. Make sure that at least the "file" is set to the
correct PDF file name:
Expand All @@ -20,6 +21,6 @@ deploying it to GitHub pages.
toolbarColor: "#ffffff"
description: "Book description"
```
6. Go to the "actions" tab and wait to until the deploy action completes.
7. Visit the generate GitHub page and to see your new flipbook.
6. Go to the "actions" tab and wait until the deployment action completes.
7. Visit the generate GitHub page and in order to see your new flipbook.
The link should look something like https://USERNAME.github.io/REPOSITORY/
Binary file added book.pdf
Binary file not shown.

0 comments on commit 0748f85

Please sign in to comment.