Skip to content

ongerit/topcon

Repository files navigation

Running

  • yarn install - install all necessary packages
  • yarn dev - watch and recompile on change (does not watch /data directory. so any changes to your data file will require restarting webpack)
  • yarn prod - build out files for prod
  • yarn _purge - cleans out dist folder
  • yarn _copy-static - copies static assets to dist folder
  • yarn _start-server - runs the development server

Data

Data is laid out in the data/data.js file as an object. Properties can be nested as you see fit. For example:

    var data = {
        page1: {
            title: 'page 1 title'
        },
        page2: {
            title: 'page 2 title'
        }
    }

This can then be used in any of your templates or partials with the this context:

    <%= this.page1.title %>

Templates/Partials

Templates and partials are all contained in ./src/templates/ - they can be organized into sub-folders within here if you'd prefer. Note that this will change your partial references.

In typical webpack-fashion, pages will be built out as they are referenced from your entry-point. In this example, the entry point is ./src/index.js - if you're going to be building out multiple pages, you can use this index file to list out all of your separate pages. Further, if you want to compile all the ejs partials in the /src directory automatically, there is code in the index.js that allows for this (currently commented out):

// initial script/style imports
import './index.scss';

// build out HTML (choose one method below)
// 1) build individual pages
import './templates/index.ejs';
// OR
// 2) automatically build all ejs files in /src
// var req = require.context('.', true, /\.ejs$/);
// req.keys().map(req);

Templates and partials follow the traditional ejs syntax. Partials can be referenced as shown in index.ejs. Partials have access to the same this context for variable access.

<h1><%= this.page1.title %></h1>
<h2><%= this.page1.subtitle %></h2>

<% include header %>

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published