ronanguilloux / silexmarkdown
Markdown-generated dynamic website, using damn simple markdown files & Silex micro-framework
Installs: 5
Dependents: 0
Suggesters: 0
Security: 0
Stars: 16
Watchers: 2
Forks: 3
Open Issues: 0
Type:app
Requires
- php: >=5.3.3
- components/bootstrap: *
- components/modernizr: *
- kriswallsmith/assetic: ~1.0.0
- mheap/silex-assetic: dev-master@dev
- michelf/php-markdown: 1.3.*@dev
- ronanguilloux/silexmarkdownserviceprovider: dev-master
- silex/silex: 1.0.*@dev
- symfony/console: ~2.3
- symfony/filesystem: ~2.2
- symfony/finder: ~2.2
- twig/twig: >=1.8,<2.0-dev
Requires (Dev)
- phpunit/phpunit: *
- symfony/browser-kit: dev-master
- symfony/css-selector: dev-master
This package is auto-updated.
Last update: 2024-10-22 20:17:20 UTC
README
Generates a markdown-based website, using Silex PHP micro-framework & your own markdown files.
A damn simple markdown-based website
Summary: markdown-files-based, Bootstrap-based CMS, w/ dynamic navigation menu generation.
Markdown files use the markdown syntax, a very easy way to add typographical enhancements in your texts.
The /resources
directory contains various markdown files, prefixed with a ordered number: Just add/modify markdown files in it: they will generate links in the navigation bar of your website.
Just start creating your own markdown files in the ./resources
directory, and your website is up.
Markdown philosophy reminder: "A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions."
Anyway, you can mix html, inline-css (even if it's bad) & markdown between html tags, using a markdon="1"
html attribute (see muffin.md page in this demo).
Design: The website uses the latest version of Twitter Bootrap; you can tweak it easely, following the Bootstrap documentation. Gears: Silexmarkdown project makes use of php-markdown library & the Silex Markdown Service Provider
Installation
$ git clone git@github.com:ronanguilloux/Silex-Markdown.git
$ curl -sS https://getcomposer.org/installer | php
$ composer.phar install --dev
Apache2 vhost example:
<VirtualHost *:80>
ServerName silexmarkdown
DocumentRoot /path/to/SilexMarkdown/web
DirectoryIndex index.php
<Directory /path.to/SilexMarkdown/web>
AllowOverride All
Allow from all
</Directory>
ErrorLog ${APACHE_LOG_DIR}/error.silexmarkdown.log
CustomLog ${APACHE_LOG_DIR}/access.silexmarkdown.log combined
</VirtualHost>
Tests
Tests need --dev option while installing dependecing using composer:
$ composer.phar install --dev
$ ln -s ./vendor/phpunit/phpunit/phpunit.php phpunit
$ ./phpunit
License
This Silex markdown-based website generator is released under the MIT License.
See the bundled LICENSE file for details.
You can find a copy of this software here: https://github.com/ronanguilloux/SilexMarkdown
Credits
- All SilexMarkdown contributors
- All fake content texts & illustrations come from http://cupcakeipsum.com
- http://silex.sensiolabs.org: PHP micro-framework based on the Symfony2 Components
- http://daringfireball.net/projects/markdown/syntax: easy-to-read and easy-to-write syntax
- http://michelf.com/projects/php-markdown: parser for Markdown and Markdown Extra
- https://github.com/lyrixx/Silex-Kitchen-Edition: a bootstrap silex application
- https://github.com/RobLoach/component-installer: installation of Components via Composer
- http://twitter.github.io/bootstrap: Twitter's front-end framework
- https://github.com/kriswallsmith/assetic: asset management for PHP
- https://github.com/ronanguilloux/SilexMarkdownServiceProvider: Silex Markdown service provider
- https://github.com/fabpot/Twig: flexible, fast, and secure template language for PHP