-
Notifications
You must be signed in to change notification settings - Fork 204
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More default pages content into an include and add to Page config docs
- Loading branch information
1 parent
4111a7b
commit 13f745f
Showing
3 changed files
with
22 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Folder default pages are **.md** files that will be treated as the index (default) page of the folder. | ||
|
||
Retype will search using the following case insensitive priority: | ||
|
||
1. `index.md` | ||
2. `readme.md` | ||
3. `default.md` | ||
4. `welcome.md` *only in the project root | ||
|
||
Within a sub-folder, if you add a Markdown **.md** file with the exact same name as the folder name, Retype will also treat that `.md` as a default page. For instance, given the following basic project structure, the **/sample/sample.md** file will function as a default page for the folder. The result will be the same as though you named it **/sample/index.md**: | ||
|
||
``` | ||
sample | ||
|-- sample.md | ||
readme.md | ||
retype.yml | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters