Skip to content

Commit

Permalink
Merge pull request #3 from thevahidal/add-demo-gif
Browse files Browse the repository at this point in the history
Add demo gif
  • Loading branch information
thevahidal committed Aug 25, 2024
2 parents ed4540b + fd8e79f commit 4931d02
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
<br />
<br />
<a href="https://thevahidal.github.io/jake">Demo</a>
<br />
<br />
<a href="https://thevahidal.github.io/jake">
<img src='docs/demo.gif' style="">
</a>
</div>

## Usage
Expand Down Expand Up @@ -49,7 +54,7 @@ To customize your website, follow these steps:
- `primary_color`: Specify your website's primary color using a hexadecimal color code (e.g., "#00897b")
- `text_align`: Specify the text alignment for your website: "right", "left" or "center" (e.g., "center")
- `gtag_id`: Your Google Analytics tracking ID (e.g., "G-33WB8LVHR6")
- `base_url`: The base URL for your website, mentioned in **1. Create a Repository** step (e.g., https://thevahidal.github.io/jake)
- `base_url`: The base URL for your website, mentioned in **1. Create a Repository** step (e.g., <https://thevahidal.github.io/jake>)

#### Sections

Expand All @@ -70,11 +75,11 @@ Each item is defined using `[[sections.items]]` and has the following components

- `title`: The title of the item (e.g., "Soul")
- `description`: A brief description of the item (e.g., "An SQLite REST and Real-time server")
- `url`: The URL associated with the item (e.g., "https://github.com/thevahidal/soul")
- `url`: The URL associated with the item (e.g., "<https://github.com/thevahidal/soul>")

</details>

### 4. Voila!
### 4. Voila

That's all you need to do. Now, you can sit back and relax while your website gets deployed. You can monitor the progress in the `Actions` tab of your repository. Once the deployment is complete, you can access your brand new one-link website at `<yourusername>.github.io` (If you chose `<yourusername>.github.io` as your repository name) or `<yourusername>.github.io/repo-name/`.

Expand Down Expand Up @@ -105,6 +110,7 @@ For more detailed instructions and information on using a custom domain with Git
4. Click on the "Run Workflow" button. A new window will appear.
5. Within the new window, click on the green "Run Workflow" button.
6. GitHub Actions will initiate the deployment process for your static content to GitHub Pages.

</details>

## Contributing
Expand Down
Binary file added docs/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4931d02

Please sign in to comment.