From d8c16d974fecd8617dce1eb0c95eb2d8a24202a2 Mon Sep 17 00:00:00 2001 From: smcdougall Date: Sun, 6 Dec 2015 14:35:39 -0500 Subject: [PATCH] Changed content to match docs changes. --- content-sample/index.md | 41 ++++++++++++----------------------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/content-sample/index.md b/content-sample/index.md index 2796420..06b852b 100644 --- a/content-sample/index.md +++ b/content-sample/index.md @@ -10,18 +10,11 @@ Congratulations, you have successfully installed [Pico](http://picocms.org/). ## Creating Content -Pico is a flat file CMS, this means there is no administration backend or -database to deal with. You simply create `.md` files in the `content-sample` -folder and that becomes a page. For example, this file is called `index.md` -and is shown as the main landing page. +Pico is a flat file CMS. This means there is no administration backend or database to deal with. You simply create `.md` files in the `content` folder and those files become your pages. For example, this file is called `index.md` and is shown as the main landing page. -If you create a folder within the content folder (e.g. `content-sample/sub`) -and put an `index.md` inside it, you can access that folder at the URL -`http://example.com/pico/?sub`. If you want another page within the sub folder, -simply create a text file with the corresponding name and you will be able to -access it (e.g. `content-sample/sub/page.md` is accessible from the URL -`http://example.com/pico/?sub/page`). Below we've shown some examples of -locations and their corresponding URLs: +When you install Pico, it comes with a `content-sample` folder. Inside this folder is a sample website that will display until you add your own content. You should create your own `content` folder in Pico's root directory and place your files there. No configuration is required, Pico will automatically use the `content` folder if it exists. + +If you create a folder within the content folder (e.g. `content/sub`) and put an `index.md` inside it, you can access that folder at the URL `http://example.com/?sub`. If you want another page within the sub folder, simply create a text file with the corresponding name and you will be able to access it (e.g. `content/sub/page.md` is accessible from the URL `http://example.com/?sub/page`). Below we've shown some examples of locations and their corresponding URLs: @@ -32,41 +25,31 @@ locations and their corresponding URLs: - + - + - + - + - +
content-sample/index.mdcontent/index.md /
content-sample/sub.mdcontent/sub.md ?sub (not accessible, see below)
content-sample/sub/index.mdcontent/sub/index.md ?sub (same as above)
content-sample/sub/page.mdcontent/sub/page.md ?sub/page
content-sample/a/very/long/url.mdcontent/a/very/long/url.md ?a/very/long/url (doesn't exist)
-If a file cannot be found, the file `content-sample/404.md` will be shown. You -can add `404.md` files to any directory, so if you want to use a special error -page for your blog, simply create `content-sample/blog/404.md`. +If a file cannot be found, the file `content/404.md` will be shown. You can add `404.md` files to any directory. So, for example, if you wanted to use a special error page for your blog, you could simply create `content/blog/404.md`. -Instead of adding your own content to the `content-sample` folder, you should -create your own `content` directory in Pico's root directory. You can then add -and access your contents as described above. - -As a common practice, we recommend you to separate your contents and assets -(like images, downloads etc.). We even deny access to your `content` directory -by default. So if you want to use a asset (e.g. a image) in one of your content -files, upload it to the (to be created) directory `assets` and use it as -follows: !\[Image Title\](%base_url%/assets/image.png) +As a common practice, we recommend you to separate your contents and assets (like images, downloads, etc.). We even deny access to your `content` directory by default. If you want to use some assets (e.g. a image) in one of your content files, you should create an `assets` folder in Pico's root directory and upload your assets there. You can then access them in your markdown using %base_url%/assets/ for example: !\[Image Title\](%base_url%/assets/image.png) ### Text File Markup @@ -93,7 +76,7 @@ There are also certain variables that you can use in your text files: * %base_url% - The URL to your Pico site; internal links can be specified using %base_url%?sub/page * %theme_url% - The URL to the currently used theme -* %meta.*% - Access any meta variable of the current page, +* %meta.*% - Access any meta variable of the current page, e.g. %meta.author% is replaced with `Joe Bloggs` ### Blogging