|
@@ -10,11 +10,24 @@ 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` folder and those files become your pages. For example, this file is called `index.md` and is shown as the main landing page.
|
|
|
-
|
|
|
-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:
|
|
|
+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.
|
|
|
+
|
|
|
+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:
|
|
|
|
|
|
<table style="width: 100%; max-width: 40em;">
|
|
|
<thead>
|
|
@@ -42,14 +55,25 @@ If you create a folder within the content folder (e.g. `content/sub`) and put an
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>content/a/very/long/url.md</td>
|
|
|
- <td><a href="%base_url%?a/very/long/url">?a/very/long/url</a> (doesn't exist)</td>
|
|
|
+ <td>
|
|
|
+ <a href="%base_url%?a/very/long/url">?a/very/long/url</a>
|
|
|
+ (doesn't exist)
|
|
|
+ </td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
|
|
|
-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`.
|
|
|
+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`.
|
|
|
|
|
|
-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 <code>%base_url%/assets/</code> for example: <code>!\[Image Title\](%base_url%/assets/image.png)</code>
|
|
|
+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
|
|
|
+<code>%base_url%/assets/</code> for example:
|
|
|
+<code>!\[Image Title\](%base_url%/assets/image.png)</code>
|
|
|
|
|
|
### Text File Markup
|
|
|
|
|
@@ -76,8 +100,8 @@ There are also certain variables that you can use in your text files:
|
|
|
* <code>%base_url%</code> - The URL to your Pico site; internal links
|
|
|
can be specified using <code>%base_url%?sub/page</code>
|
|
|
* <code>%theme_url%</code> - The URL to the currently used theme
|
|
|
-* <code>%meta.*%</code> - Access any meta variable of the current page,
|
|
|
- e.g. <code>%meta.author%</code> is replaced with `Joe Bloggs`
|
|
|
+* <code>%meta.*%</code> - Access any meta variable of the current
|
|
|
+page, e.g. <code>%meta.author%</code> is replaced with `Joe Bloggs`
|
|
|
|
|
|
### Blogging
|
|
|
|