Skip to content

Commit 9cd26f2

Browse files
fix: added create index.md file to shortcode steps (#29)
1 parent a227236 commit 9cd26f2

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,20 @@ This theme contains the following custom shorcodes:
5555
### Includes
5656

5757
This theme contains a custom shortcode called "includes" that lets you reuse content.
58-
To use this shortcode, you must add an "includes" folder to the folder that contains your site content (e.g., `content/includes`).
58+
59+
To use this shortcode:
60+
61+
1. Add an "includes" folder to the folder that contains your site content (for example, `content/includes`).
62+
2. In the includes folder, create an `index.md` file and add these lines:
63+
64+
```text
65+
---
66+
headless: true
67+
---
68+
```
5969

6070
You can reuse the content of any file in the includes directory using the following shortcode syntax:
6171

6272
```md
6373
{{< include "filename.md" >}}
6474
```
65-
66-

0 commit comments

Comments
 (0)