From: Aaron Taylor Date: Sat, 7 Nov 2020 12:03:23 +0000 (-0800) Subject: Updated formatting of CMless README for use with `discount`. X-Git-Url: http://git.subgeniuskitty.com/cmless/.git/commitdiff_plain/ac6fb0d4d91f156c701bd3fcf6c57842c610c0ac Updated formatting of CMless README for use with `discount`. --- diff --git a/README.md b/README.md index 47faa0d..1b014db 100644 --- a/README.md +++ b/README.md @@ -24,74 +24,60 @@ Installation Example - Debian Linux Enable CGI scripts: -``` -a2enmod cgi -``` + a2enmod cgi Create and enable an Apache vhost. -``` -vi /etc/apache2/sites-available/cmless.subgeniuskitty.com -``` - -``` - - DocumentRoot "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com" - ServerName cmless.subgeniuskitty.com - ServerAdmin webmaster@subgeniuskitty.com - ErrorLog /var/log/apache2/error_log.cmless.subgeniuskitty.com - CustomLog /var/log/apache2/access_log.cmless.subgeniuskitty.com combined - AddHandler cgi-script .py - - Options -ExecCGI -Indexes - AllowOverride None - Order allow,deny - Allow from all - - - Options ExecCGI - AllowOverride None - Order allow,deny - Allow from all - - RewriteEngine On - RewriteRule (.*) /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/site/$1 - RewriteCond %{REQUEST_FILENAME} !-f - RewriteRule .* /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin/cmless.py - -``` - -``` -a2ensite cmless.subgeniuskitty.com -service apache2 reload -``` + vi /etc/apache2/sites-available/cmless.subgeniuskitty.com + + + DocumentRoot "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com" + ServerName cmless.subgeniuskitty.com + ServerAdmin webmaster@subgeniuskitty.com + ErrorLog /var/log/apache2/error_log.cmless.subgeniuskitty.com + CustomLog /var/log/apache2/access_log.cmless.subgeniuskitty.com combined + AddHandler cgi-script .py + + Options -ExecCGI -Indexes + AllowOverride None + Order allow,deny + Allow from all + + + Options ExecCGI + AllowOverride None + Order allow,deny + Allow from all + + RewriteEngine On + RewriteRule (.*) /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/site/$1 + RewriteCond %{REQUEST_FILENAME} !-f + RewriteRule .* /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin/cmless.py + + + a2ensite cmless.subgeniuskitty.com + service apache2 reload Clone the CMless git repository into the Apache vhost directory. -``` -cd /mnt/data/apache_vhosts -git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com -chown -R www-data:www-data ./cmless.subgeniuskitty.com -``` + cd /mnt/data/apache_vhosts + git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com + chown -R www-data:www-data ./cmless.subgeniuskitty.com -Clone your content into the site/ folder. If you with to use a different -folder, edit the configuration options in bin/config.py accordingly. If this is -your first CMless site, see the site_sample/ folder for an example site using -Markdown. +Clone your content into the `site/` folder. If you with to use a different +folder, edit the configuration options in `bin/config.py` accordingly. If this +is your first CMless site, see the `site_sample/` folder for an example site +using Markdown. -``` -cd /mnt/data/apache_vhosts/cmless.subgeniuskitty.com -git clone your_site_content_repo site -chown -R www-data:www-data ./site -``` + cd /mnt/data/apache_vhosts/cmless.subgeniuskitty.com + git clone your_site_content_repo site + chown -R www-data:www-data ./site Install an appropriate document processor for your content and set the -markup_processor configuration option in bin/config.py accordingly. Your markup -engine should accept text via stdin and output HTML on stdout. +`markup_processor` configuration option in `bin/config.py` accordingly. Your +markup engine should accept text via `stdin` and output HTML on `stdout`. -``` -apt-get install discount -``` + apt-get install discount -Edit bin/config.py and set all configuration options according to the steps +Edit `bin/config.py` and set all configuration options according to the steps taken during installation. Each option is commented inside the file.