Skip to content

Commit

Permalink
feat(docs): update content to 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
GabsEdits committed Jun 15, 2024
1 parent 9f1c85d commit c355b29
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 35 deletions.
46 changes: 22 additions & 24 deletions docs/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,21 +109,20 @@ The message you want to share
### Input

```md
::: info
This is an info box.
:::
> [!INFO]
> This is an info box.

::: tip
This is a tip.
:::
> [!TIP]
> This is a tip.

::: warning
This is a warning.
:::
> [!WARNING]
> This is a warning.

::: danger
This is a dangerous warning.
:::
> [!DANGER]
> This is a dangerous warning.

> [!NOTE]
> This is a note.

::: details
This is a details block.
Expand All @@ -132,21 +131,20 @@ This is a details block.

### Output

::: info
This is an info box.
:::
> [!INFO] Info
> This is an info box.
::: tip
This is a tip.
:::
> [!TIP] Tip
> This is a tip.
::: warning
This is a warning.
:::
> [!WARNING] Warning
> This is a warning.
::: danger
This is a dangerous warning.
:::
> [!DANGER] Danger
> This is a dangerous warning.
> [!NOTE] Note
> This is a note.
::: details
This is a details block.
Expand Down
14 changes: 13 additions & 1 deletion docs/guide/edit-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Customizing the Articles in your Aplós template is a straightforward process, s

```ts
articles: {
message: "Thanks for reading this article",
giscus: {
repo: "Foo/Bar",
repoid: "ExaMpLe",
Expand All @@ -67,13 +68,24 @@ Customizing the Articles in your Aplós template is a straightforward process, s
},
```

> [!WARNING] Warning
> Make sure to replace the `repo`, `repoid`, and `categoryid` with your own values.
The `giscus` object contains the variables to make the [Giscus](https://giscus.app/) comments show, for more information check the [Giscus documentation](https://giscus.app/).

> [!WARNING] Warning
> [!INFO] Info
> The variables above are only needed if you use Giscus as the comment provider in your articles. If you use ActivityPub, you can ignore these variables.
#### Message after the article

You can change the message that appears after the article by changing the `message` variable inside the `articles` object:

```ts
articles: {
message: "Thanks for reading this article",
},
```

### Changing theme settings

With version `2.0.0`, you can now configure more settings for the theme. For example, if you want headings to have numbers, you can change the following variables inside the `theme` object:
Expand Down
23 changes: 13 additions & 10 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export default {
} satisfies Theme;
```

> [!TIP] Tip
> If you also want to add aditional styles, you can create a CSS/SCSS file inside the `theme` folder and import it in the `index.ts` file.
### With Articles or without Articles
Expand Down Expand Up @@ -148,6 +149,7 @@ For example, to import a CSS file, add the following line to the `index.ts` file
import "./styles.css";
```

> [!TIP] Tip
> It's recommended to have the `styles.css` file in the same directory as the `index.ts` file, the `.vitepress/theme/` folder.

Inside the `styles.css` file, you can add custom styles to modify the appearance of your content, or even adding custom components.
Expand All @@ -166,17 +168,18 @@ You can modify the width of the content in Aplós by changing the `--content-wid

You can style images in your content using various options provided by Aplós. Here's how to apply each styling option:

- **Not Rounded**: Remove the border radius from an image.
- **Static**: Prevent an image from being resized when hovered or active.
- **not-rounded**: Remove the border radius from an image.
- **static**: Prevent an image from being resized when hovered or active.
- **Size Options**:
- **Small**: Make an image smaller.
- **Medium**: Make an image medium-sized.
- **small**: Make an image smaller.
- **medium**: Make an image medium-sized.
- **Visual Effects**:
- **Shadow**: Add a shadow to an image.
- **Monochrome**: Make an image monochrome.
- **Invert**: Invert the colors of an image.
- **Blur**: Blur an image.
- **Sepia**: Add a sepia effect to an image.
- **shadow**: Add a shadow to an image.
- **mono**: Make an image monochrome.
- **invert**: Invert the colors of an image.
- **blur**: Blur an image.
- **sepia**: Add a sepia effect to an image.
- **pixel**: Pixelate an image.
- **Transparency**: Make an image transparent.

To apply any of these options, use the following syntax:
Expand All @@ -191,7 +194,7 @@ For example, to make an image small, use the following syntax:
![My image](./image.png#small)
```

> [!TIP]
> [!TIP] Tip
> You can combine multiple options by separating them with a comma. For example, to make an image small and add a shadow, use the following syntax:
>
> ```md
Expand Down

0 comments on commit c355b29

Please sign in to comment.