Lightweight flat file CMS written in PHP
PHP CSS HTML ApacheConf
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
files
theme
weasel-cms
.gitignore
.htaccess
LICENSE
README.md
index.php

README.md

WeaselCMS

Project Website: http://weasel.moro.es

Weasel. Lightweight flat file CMS written in PHP

Weasel CMS is an Open Source, very simple and lightweight Content Management System written in PHP and built specifically for small websites.

Easy to setup, Weasel CMS uses a flat file system (No database) so you just have to unzip and upload it to the server and you are all set to add content with its easy to use simplistic UI.

Weasel CMS is a very flexible CMS that can be easily used as a skeleton to build your small project up from.

  • Very Simple : No clutter and confusion, a simplistic site editor and UI.
  • Mobile Friendly : Weasel has a minimalist user interface that works nice on all devices.
  • No Database : Weasel is a Flat file CMS, which means no database is behind it.
  • Open Source : Weasel is free and open source, released under the MIT license.
  • Lightweight : Full CMS weights like a JPG image and is built in a little bunch of files.
  • Easy Setup : As straightforward as possible, just upload it and use it. No complicated configuration.
  • Markdown ready : Easy editing of your page by using Markdown or HTML.
  • Custom theming : Very easy to create new themes or modify the existing templates.

Docs

Requirements

To run Weasel CMS you only need PHP >= 5.3 running on your server. Apache mod_rewrite module enabled is recommended but not a requirement.

Installation

  1. Download the latest version of Weasel CMS from the GitHub repository : https://github.com/alterebro/WeaselCMS/releases/latest
  2. Upload the files to your PHP Server
  3. Change permissions to the following files / folder to make them writable: config.php, db.dat, /files.
  4. That's all, start using Weasel CMS.

Default installation user/pass pair is :

user : weasel
pass : weaselcms

You can change this login details on the config.php file

--

Theming

Themes are located on the /theme folder and the main template file is the ìndex.html HTML file. Variables are placed using the double curly bracket syntax {{ $variable_name }} i.e: in order to print the page title you'll put the following code in the html template: {{ $_CMS['page']['title'] }}

  • Available Themes
    • A couple of basic themes bundled on the Weasel CMS theme folder where you can start to hack and play around with them.
    • @iskono's theme based on dopetrope by html5up: iskono/WeaselCMS-THEME

Variables

All the elements that you can use when theming your website using Weasel CMS data are encapsulated in an array called $_CMS, this array has got the following variables within it.

  • $_CMS['site'] :

    • ['site_language'] ISO 639-1 Language Code, usually the two letter identifier like: EN, ES, FR ...
    • ['site_title'] : Returns the current weather in Beijing, China ... nah, it's actually the Site Title.
    • ['site_description'] : mainly for seo purposes
    • ['site_keywords'] : Same as above.
    • ['path] : base directory ( dirname($_SERVER['PHP_SELF']) )
    • ['url] : url where the website resides ( HTTP_HOST + path )
  • $_CMS['pages'] : Variable containing all the data of every page in case you want to loop over it. Each page contains the following properties described below on the $_PAGE variable.

  • $_CMS['page'] :

    • ['title'] The page title
    • ['description'] Short description of the page
    • ['content'] This is stored as Markdown but it returns the parsed HTML code of the pages content
    • ['tags'] Comma separated tag values
    • ['datetime'] machine-readable date/time in the form : 1914-12-20 08:30:45
    • ['timedate'] Verbose time-date returned by default in the form (i.e) : Thursday 12th of February 2009 @ 04:25 AM ( Date: l jS \of F Y @ h:i A )
    • ['link'] Returns the full url friendly link of the page in case mod_rewite exists on the Apache modules or the link with a url get variable in case it doesn't ?p=url-slug
    • ['slug'] the slug defined on the admin area.
  • $_CMS['is_page'] : Boolean returns if it is a page or not ( Useful to filter the index/home page )

  • $_CMS['menu'] : Retuns an HTML unordered list with all the active pages linked to their pages. With an active class on the current element ( class="active" )

  • $_CMS['prev_page'] full url friendly link to the previous page if exists, otherwise will return a link to the site url.

  • $_CMS['next_page'] full url friendly link to the next page if exists, otherwise will return a link to the site url.

  • $_CMS['is_404'] : Boolean returning if the page is a 404 not found file.

Adding extra variables

On the config.php file, you can add more 'key' => 'value' items to the returned array so you can access to them later on the main template. They will be encapsulated in the parent array $_CMS['site']

For example, by adding at the end of the config array the new pair : 'my_var' => 'my_value'

<?php return array (
  'user' => 'weasel',
  'pass' => 'weaselcms',
  'db' => 'data.dat',
  'site_language' => 'en',
  ...
  'files_folder' => '../files',
  'my_var' => 'my_value',
);

You can later call it by using the bracket syntax : {{ $_CMS['site']['my_var'] }}

--

Weasel XML Data

A basic sitemaps and rss feed files are provided by default with WeaselCMS and they are both accessible through the root of the site:


Libraries used in Weasel CMS

Download

Get the latest release on the Weasel CMS GitHub repository : https://github.com/alterebro/WeaselCMS/releases/latest

MIT Open Source License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.