PhileCMS / Phile

A flat file CMS with a swappable parser and template engine.
https://philecms.github.io/
Other
257 stars 49 forks source link

Actualize basic docs #38

Closed Frodox closed 10 years ago

Frodox commented 10 years ago

It's just a note for you, dont forget to actualize a basic doc

I just start to migrate from Pico :D and.. I've found a doc-mismatch.

For example, I can't use {{ page.date_formatted }} as noted here , so I should rewrite my theme to use {{ page.meta.date|date(config.date_format) }} instead. I think, it's good to collect all API-changes in one place :)

I even can make a PR, if you help me with information :)

Frodox commented 10 years ago

Oh, actually {{ page.meta.date|date(config.date_format) }} always shows the current date (today) and {{ current_page.meta.date|date(config.date_format) }} is the same. Ok, I'll investigate Blog-Theme .. because it works

james2doyle commented 10 years ago

I will take care of the docs. But you are right, it works in the blog.

You can also check out my site, it's been running on Phile since the beginning.

https://github.com/james2doyle/ohdoylerules.com

Frodox commented 10 years ago

Yup, your site is pretty nice :+1: Ok, I will check out it

james2doyle commented 10 years ago

A side note too, I think that if you don't have a page date meta set, instead of an error it just uses today's date.

But @NeoBlack might be able to confirm.

Possibly today will finally be the day where I can make some Phile videos.

Frodox commented 10 years ago

Also, I think it would be great to somehow highlight an important information..

like folder structure (it differents from Pico's one) and so on. Thus, content/category/dogs/about-huskies.md will become /category/dogs/about-huskies but in Pico it's not so logically: content/about-huskies/index.md will become /about-huskies And it is not so obvious for some users (careless)

Frodox commented 10 years ago

A side note too, I think that if you don't have a page date meta set, instead of an error it just uses today's date.

I have date meta in all articles.. like

/*
    Title: some title
    Description: descrip
    Date: 2013/10/27
    Tags: php,programming
*/```
james2doyle commented 10 years ago

Oh ok well it wouldn't be the "no meta" issue then.

Phile is actually the same as Pico when it comes to the path style.

You can see it in the default content from the basic install.

https://github.com/PhileCMS/Phile/tree/master/content/sub

Frodox commented 10 years ago

Oh ok well it wouldn't be the "no meta" issue then.

No, it's actually "no meta" issue :)

I just check it

Date: 2013/10/27

works fine, but

       Date: 2013/10/27

will not. (works on Pico)

Could you fix it...? Just skip all whitespaces (space and tabs) at start of every line =)

Frodox commented 10 years ago

Also I noteced a new bug (sorry =) ) If there is no template (like post.html and so on) it fails (Fatal error: Uncaught exception 'Twig_Error_Loader' with message 'Unable to find template "post.html")

could you, for example, fallback to index.html, like in Pico, ot any other suggestions..?

james2doyle commented 10 years ago

Ah alright. So we just need to make sure to strip the tabs in the meta then.

I can make a new issue for the no template error.

STOWouters commented 10 years ago

It's a good idea do update the docs, because I was slightly confusing how to add metadata in your markdown files:

On content/index.md, it was telling me to add metadata in the markdown files in this way:

<!--
Title: Welcome
Description: This description will go in the meta description tag
Author: Joe Bloggs
Date: 2013/01/01
Robots: noindex,nofollow
-->

..while on the gh-pages doc:

/*
Title: Welcome
Description: This description will go in the meta description tag
Author: Joe Bloggs
Date: 2013/01/01
Robots: noindex,nofollow
*/
james2doyle commented 10 years ago

You can actually use both comment block styles. But yeah the docs need to be updated.

I'll try to take care of these things today.

james2doyle commented 10 years ago

Updated docs to reflect these issues.

Frodox commented 10 years ago

Oh, but now it looks like page has not any date at all =) Ok, it's at your discretion.