README.md 1.9 KB

Comasy

COntent MAnagement SYstem

This is a simple POSIX compliant CMS (Content management system) script to create a web standard static website. Generator of static website, blogs and broadcasts.

This package is compatible with ShellCheck, StandardJS and LibreJS.

Install

To install you need to have the following pieces of software on your computer:

  • Debian Almquist Shell
  • GNU core utilities
  • GNU stream editor

These packages are installed by default in most GNU/Linux distributions. If not installed, you can install via your operating system's package manager. For Debian-like GNU/Linux distributions this would be:

# apt-get install coreutils dash sed

Usage

Change the global variables in the file ./global.sh

export SITEBASE="https://sepbit.com"
export SITETITLE="SEPBIT"
export SITESUBTITLE="SEPBIT is a technology company"
export SITEICON="$SITEBASE/assets/images/icon.png"
export SITEAUTHOR="Vitor Guia"
export SITERIGHTS="1991-2019 $SITEAUTHOR"

Page structure

Template ./src/templates/[pages|broadcasts|posts].html

Content ./src/[pages|broadcasts|posts]/episode-1.html

Variables ./src/[pages|broadcasts|posts]/episode-1.sh

Broadcasts ./src/statics/assets/sounds/episode-1.ogg

export title="Episode 1"
export summary="Episode 1 summary"

Home page

Content ./src/home.html, variables ./src/home.sh

Build

Assign execute permission to file ./comasy.sh

$ chmod +x ./comasy.sh
$ ./comasy.sh

Built directory structure

./www/assets/sounds/episode-1.ogg
./www/episode-1/index.html
./www/index.html
./www/broadcasts.xml
./www/broadcasts/index.html
./www/post-1/index.html
./www/posts.xml
./www/posts/index.html
./www/sitemap.xml

Contributing

Pull Requests not accepted.

License

GPL-3.0-or-later, please see COPYING file for more information.