Skip to content

Commit

Permalink
doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daiyanze committed Apr 14, 2022
1 parent bc21c54 commit a49eb10
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ A theme plugin of Gatsby for those who enjoys building their blog site with mini
- [Adding Site Metadata](#adding-site-metadata)
- [Adding Authors](#adding-authors)
- [Adding Posts](#adding-posts)
- [Adding Styles](#adding-styles)
- [Adding Site Logo & Cover Image](#adding-site-logo--cover-image)
- [Full Fledged Example](#full-fledged-example)
- [Others](#others)
Expand Down Expand Up @@ -294,6 +295,25 @@ slug: posts/gatsby-plugin-options

```

## Adding Styles

Sometime you may need to write HTML directly in the post page. Since not all of the HTML tags (e.g. `<div>`) are styled by this theme, there might be some unexpected layout arrangements.
This theme provides some CSS utilities to let you directly adjust those raw HTML tags. It's also viable to approach this via [Tailwindcss](https://tailwindcss.com) style.

Here are the CSS utilities class names. See their definitions in this file: [./packages/gatsby-theme-pitayan/src/assets/css/utilities.css](./packages/gatsby-theme-pitayan/src/assets/css/utilities.css)

- Post Width
- .mark-w-sm
- .mark-w-md
- .mark-w-lg
- .mark-w-2l
- Border
- .border-t-white
- .border-t-black
- .text-inverted
- .bg-inverted
- .border-inverted

## Adding Site Logo & Cover Image

It supports mainstream picture types such as `jpg` / `png` / `svg` etc.
Expand Down

0 comments on commit a49eb10

Please sign in to comment.