Skip to content

Commit 4f5418e

Browse files
committed
Update README.md
1 parent 73d19e3 commit 4f5418e

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
1-
# pico-nestedpages
2-
Pico Plugin to let one page be embedded in another
1+
# Pico Nested Pages
2+
3+
A [Pico CMS](http://picocms.org) plugin to allow one MD page embedded in another.
4+
5+
This plugin adds a custom 'tag' to MarkDown that allows one page to be included in another. The page that's included is literally pasted into the page's MarkDown, and so gets rendered into HTML. The included file doesn't have to have the .md suffix, so it's possible to use files that Pico can't 'see'. With this, it's possible to have editable units used on one or many pages, for example to provide navigation, 'recent posts' or other such things (which may be hand-edited, or generated by some sort of offline process).
6+
7+
To use the plugin, all that's required is the special tag with the path to a file to include. For example, if there's a file called /inc/navigation.md, then it can be included in a page with the following:
8+
9+
`@[/inc/navigation.md]`
10+
11+
The path to the included file must be relative to the content root (/content). The file you include is added verbatim before Pico rendering. If you accidentally decide to include a non-text file, you'll end up with unfortunately weird results.

0 commit comments

Comments
 (0)