Skip to content

Commit

Permalink
doc: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tomowang committed Jan 18, 2024
1 parent 8435526 commit 6a9114b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
![MIT license](https://img.shields.io/github/license/tomowang/hugo-theme-tailwind)
[![gohugo](https://img.shields.io/badge/Made_with-Hugo-blue)](https://gohugo.io/)
[![tailwindcss](https://img.shields.io/badge/Made_with-Tailwind_CSS-blue)](https://tailwindcss.com/)
![GitHub Repo stars](https://img.shields.io/github/stars/tomowang/hugo-theme-tailwind)

Hugo theme built using [Tailwind CSS](https://tailwindcss.com/), mostly for bloggers.

Expand Down Expand Up @@ -105,6 +106,19 @@ link = 'https://www.facebook.com/'

## Development

### Extend functionality

The theme folder structure is as follows:

![hugo theme layout stracture](https://raw.githubusercontent.com/tomowang/hugo-theme-tailwind/main/images/hugo-theme-layout-structure.png)

You can extend the theme by creating following files in your site folder:

* `layouts/partials/custom_head.html`
* `layouts/partials/custom_footer.html`

### Update stylesheets

This theme use Tailwind CSS for styling. If you want to make some changes,
use `pnpm install` to install dependencies.

Expand Down
Binary file added images/hugo-theme-layout-structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/prototype.png
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 6a9114b

Please sign in to comment.