Creating pages in Raneto is as simple as creating a Markdown file (.md
) with you favourite text editor.
There are several important aspects to your files that you need to pay attention to when you create pages.
File Location
All of your Markdown files must go in the content
folder in the root of the application (this can be
configured in config.js
). You can add as many sub-folders as you like in the content folder, but only
.md
files within the content
folder (or sub-folders) will be recognised.
You can use sub-folders as a way of creating “categories” of pages. For example if you create a sub-folder
called using-my-product
all of the pages inside that folder will appear under the Using My Product
category in Raneto. You can create as many levels of sub-folder as you like but they will always appear
as a top level category.
Sub-folders will also be added to the page URL or “slug”. See file naming below for more information.
File Name
The name of the file defines what URL or “slug” is used to navigate to that page. For example if you create
a file called my-example-page.md
you would visit that page be navigation to example.com/my-example-page
.
Below is a table of example folder and file names and the URL’s they would have in Raneto.
File Location | URL |
---|---|
content/hello.md |
/hello |
content/my-example-page.md |
/my-example-page |
content/hello/my-example-page.md |
/hello/my-example-page |
content/some/sub/folder/page.md |
/some/sub/folder/page |
If a file cannot be found the error.html
template will be shown.
File Markup
Pages are created using Markdown. If you are new to Markdown please refer to the syntax guide for more information. Pages can also contain regular HTML.
At the top of a page you can place a block comment to specify certain attributes of the page. For example you can specify the page title or a description to be used by search engines. Specifying page meta is optional.
/*
Title: My Page Title
Description: Optional description for search engines
*/
Note that if no meta title is specified the filename will be used to generate a page title.
You can also use certain variables in your Markdown pages which will be replaced with the values you set in your config.
- %base_url%: The base URL of your site
- %image_url%: The base URL of your images folder (
public/images
)