HackmanClub/tapestry
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Bashy 2025-09-24 20:01:57 +03:00 • committed by GitHub
parent bfad59d5e8
commit 600e9a5213
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -2,7 +2,7 @@
Tapestry is a Hexo theme designed for tumblr style gallery blog feed. Tapestry is a Hexo theme designed for tumblr style gallery blog feed.
I am using this theme for a personal blog, or you can check the official theme preview. I am using this theme for a [personal blog](https://blog.bashynx.com/), or you can check the [official theme preview](https://tapestry.demo.bashynx.dev/).
--- ---
@ -15,7 +15,7 @@ cd your-hexo-project
git clone https://github.com/HackmanClub/tapestry.git themes/tapestry git clone https://github.com/HackmanClub/tapestry.git themes/tapestry
``` ```
1. Set the theme in Hexo’s main \_config.yml: 1. Set the theme in Hexo’s main `_config.yml`:
```yaml ```yaml
theme: tapestry theme: tapestry
@ -31,7 +31,7 @@ npm install sharp
## 2. Configuration ## 2. Configuration
The theme uses its own \_config.yml inside themes/tapestry/. You will need to copy / rename \_EXAMPLE_config.yml as a starting point: The theme uses its own `_config.yml` inside `themes/tapestry/`. You will need to copy / rename `_EXAMPLE_config.yml` as a starting point:
```bash ```bash
cp themes/tapestry/_EXAMPLE_config.yml themes/tapestry/_config.yml cp themes/tapestry/_EXAMPLE_config.yml themes/tapestry/_config.yml
@ -41,11 +41,11 @@ cp themes/tapestry/_EXAMPLE_config.yml themes/tapestry/_config.yml
#### Site Settings #### Site Settings
- avatar, banner, favicon: paths to your images. - `avatar`, `banner`, `favicon`: paths to your images.
- primary_color: main color for your theme. - `primary_color`: main color for your theme.
- tag_border: add borders around tags. - `tag_border`: add borders around tags.
- sidebar: show or hide the sidebar. - `sidebar`: show or hide the sidebar.
- scarves: enable or disable scarves links. - `scarves`: enable or disable scarves links.
#### Scarves #### Scarves
@ -65,11 +65,11 @@ scarf:
alt: Example alt: Example
``` ```
- url – link target - `url` – link target
- image – path to scarf image - `image` – path to scarf image
- icon – FontAwesome icon class - `icon` – FontAwesome icon class
- enable – show/hide scarf - `enable` – show/hide scarf
- alt – accessibility text - `alt` – accessibility text
#### Social Links #### Social Links
@ -98,17 +98,17 @@ sidebar_menu:
url: https://hexo.io/docs/setup url: https://hexo.io/docs/setup
``` ```
- enable – show/hide - `enable` – show/hide
- name – link text - `name` – link text
- url – destination - `url` – destination
--- ---
## 3. Using Thumbnails ## 3. Using Thumbnails
- Put post images in source/images/ - Put post images in `source/images/`
- The theme generates thumbnails automatically in source/thumbnails/ - The theme generates thumbnails automatically in `source/thumbnails/`
- Use small- or large- in templates depending on your layout. - Use `small-` or `large-` in templates depending on your layout.
Example in a template: Example in a template:
@ -118,7 +118,7 @@ Example in a template:
<% } %> <% } %>
``` ```
> ⚠️ Only shows image if post.photos exists. > ⚠️ Only shows image if `post.photos` exists.
--- ---
@ -131,5 +131,5 @@ hexo clean
hexo s hexo s
``` ```
- Visit http://localhost:4000 - Visit `http://localhost:4000`
- Changes in templates or CSS are reflected immediately. - Changes in templates or CSS are reflected immediately.