Skip to content

Commit

Permalink
[TASK] update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lisa-Maria Schedlberger committed Apr 12, 2024
1 parent c85351a commit 44d850a
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions local_packages/portfolio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,18 @@ The portfolio provides a set of often used content elements for portfolio pages
- **Project Teaser**: The project teaser shows three projects from the listing and provides a link to the projects list.


## Portfolio Configuration & Styling
## Portfolio Styling & Sets Configuration
As soon as the setup is done, the portfolio can be adapted to your personal style and needs, this can be done by some basic configurations.

### Example: Theme
**Example: Theme**
The portfolio provides two themes:
- dark mode
- light mode

You can change the theme in the settings with ```style.data.theme```. In the following table all options are shown.
You can change the theme in the settings with ```style.data.theme```.

### Sets Configuration
In the following table all options for the sets configration are shown.

| Identifier | Description | Default | Possible Options |
|---------------|-----------------------------|----------|------------------------------|
Expand All @@ -46,10 +49,9 @@ You can change the theme in the settings with ```style.data.theme```. In the fol
|```style.contentAlignment```|Defining the content alignment|```center```|```center```, ```left```|
|```style.logo.path```|Defining the logo path in fileadmin|```/fileadmin/logo/typo3_logo.svg```|define the correct path|


## Socials

For adding links to your social media accounts you just need to add links to your accounts in the sets. The following social media channels are yet supported:
For adding links to your social media accounts you just need to add links to your accounts in the sets. The following social media channels are yet supported and can be shown with an icon.

| Channel| Identifier|
|--------|-----------|
Expand Down

0 comments on commit 44d850a

Please sign in to comment.