Skip to content

Mosquito is a mini flyweight Static Site Generator written in PHP that can also be used as simple CMS, it converts Markdown files into HTML using the folder structure where they are stored as URL router model

alterebro/mosquito

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 

mosquito

mosquito is a Static Site Generator written in PHP that can also be used as a simple Content Management System. It converts your markdown files into HTML using the folder structure as URL router.

Further documentation is available on the mosquito website, which was generated (♫♫ obviously ♫♫) using mosquito : http://alterebro.github.io/mosquito/

Requirements

  • PHP ( >= 5.4.0 ), when using mosquito as CMS, the Apache mod_rewrite is required in order to create the friendly URLs.

One-line Installer

Execute the following command on a terminal and a mosquito site will be available on http://localhost:8000

mkdir mosquito && curl -L https://github.com/alterebro/mosquito/tarball/v0.2.0 | tar zx -C mosquito --strip-components=1 && cd mosquito && php -f index.php build && php -S localhost:8000 -t dist

Basic Info

Generating a Static Site :

  • Get the mosquito generator, you can clone it from the github repo :
$ mkdir mosquito
$ cd mosquito
$ git clone --depth=1 git://github.com/alterebro/mosquito.git
  • Create / modify your content and store it on the /content folder.
  • Build your mosquito site :
$ # build static site
$ php -f index.php build
  • By default, the site is generated on the /dist folder (you can change that) to check everything worked as expected, start a local web server :
$ # starts server
$ php -S localhost:8000 -t dist 	

Libraries Used :

License

The MIT License (MIT)

Copyright (c) 2016 Jorge Moreno

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 NONINFRINGEMENT. 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.

About

Mosquito is a mini flyweight Static Site Generator written in PHP that can also be used as simple CMS, it converts Markdown files into HTML using the folder structure where they are stored as URL router model

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages