No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
pages
src
.gitignore
.npmignore
LICENSE
Makefile
README.md
fs.js
git.js
html.js
package.json
pg.js
pug.js
rollup.config.js

README.md

penguinjs

This is a simple building chain for a CMS.

Directory structure

  • data/ This contains the data of the CMS. Usually the user input.
  • pages/ This contains the template source files for the pages (any template language).
  • objects/ This contains the template sources for the objects (any template language).

Tools

bin/create_component_map.js

This creates an index file for the components and writes it to stdout. You should place the resulting file to components.js. The map is based on the selected field from the package.json.

$ bin/create_component_map.js --query webdesignio.components >components.js

Commands

serve

This starts a development server on http://localhost:3000 to be used to develop a website. It also starts watchify and recreates the client runtime on changes (including recreation of components.js based on components/ and package.json).

Available CLI options

  • -v The view engine to use (default is html [dust] but there is also pug)

pack

This packs all the relevant files, builds the component-renderer-script and places all under pack/.

Available CLI options

  • -p The directory to store the resulting files (default docs/)
  • -v The view engine to use (default is html [dust] but there is also pug)

build

This renders all templates under docs/ statically.

Available CLI options

  • -p The directory where the packed files are stored (previously generated using pack, default is docs/)
  • -d The directory where data files reside in (default is data/)