Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge docs patch 1 #3

Merged
merged 4 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Documentation/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ import { defineConfig } from 'vitepress'
export default defineConfig({
title: "Imgal Documentation",
description: "Documentation for Imgal by KioydioLabs",
head: [['link', { rel: 'icon', href: '/public/icon.jpg' }]],
head: [
['link', { rel: 'icon', href: '/public/icon.jpg' }],
['meta', { name: 'theme-color', content: '#75a300' }]
] ,
themeConfig: {
search: {
provider: 'local'
Expand Down
4 changes: 4 additions & 0 deletions Documentation/creating-an-image-gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Extract the Imgal zip file.

In a folder, place the `imagal.py` file and the `templates` folder found in the zip file.

::: warning Warning
**Do not move the `templates` folder or rename or modify the files in any way as this will break Imgal.**
:::

In the same folder, create another folder, and place your images in it.

## Creating the image gallery
Expand Down
6 changes: 1 addition & 5 deletions Documentation/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ hero:
align: center
name: "Demo Imgal Galleries"
text: "Choose a theme"
pageClass: demo-page
actions:
- theme: brand
text: Sleek
Expand All @@ -21,9 +22,4 @@ hero:
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #75a300, rgb(0,163,149));
}
.main{
display: flex;
flex-direction: column;
align-items: center;
}
</style>
4 changes: 3 additions & 1 deletion Documentation/linux-prereq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ To do that, open the Terminal and run the following command
pip install Pillow
```

<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>
::: tip Note
If the command above doesn't work, or you get an error that pip could not be found, run the command below instead
:::

```Shell
python -m install Pillow
Expand Down
4 changes: 3 additions & 1 deletion Documentation/windows-prereq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ To do that, open Powershell and run the following command
pip install Pillow
```

<note>If the command above doesn't work, or you get an error that pip could not be found, run the command below instead</note>
::: tip Note
If the command above doesn't work, or you get an error that pip could not be found, run the command below instead
:::

```Shell
python -m install Pillow
Expand Down