Giter VIP home page Giter VIP logo

cataclysm's Introduction

cataclysm

Static Website Builder

YSK

  • Cataclysm uses ./src directory (rather than scattering files around repository root) to keep all your hard work in one directory.

Links

Installation

npm i -g cataclysm

Usage

Run cataclysm in template/website directory.

Conventions

Main configuration file is ./cataclysm.mjs

Template data file is ./data/index.mjs the data folder allows for extra files such as colors.json or db/tables/bobby.json

Both are to return a promise.

Configuration

System configuration file is called ./cataclysm.mjs

Data

There must be some way of fetching a properly structured data that is fed into the template system.

I introduce the concept of ./src/data/index.mjs, it is a JavaScript module that returns a promise, upon execution it will return all the data the templates need.

Please create a ./src/data/index.mjs module in the root of your project.

// Example data module

import {inspect} from 'util';
import fs from 'fs-extra';
import path from 'path';
import take from 'lodash/take.js';
import reverse from 'lodash/reverse.js';
const data = {};
export default async function () {
  // you can process data before returning...
  return data;
}

cataclysm's People

Contributors

catpea avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.