GitXplorerGitXplorer
l

cory

public
60 stars
4 forks
0 issues

Commits

List of commits on branch master.
Unverified
c4303683f80558d7d738edbefa41549437142789

2.0.1

lleo committed 7 years ago
Unverified
126c64be211753a1dea84d927525d13aa041c748

Deprecation notice added

lleo committed 7 years ago
Unverified
5b4bd587de7229dde18cf80d389ea4bdf3c07f2b

Lowercased text files

lleo committed 7 years ago
Verified
28f14b5b7428a404ae9adf5dca3a2772bb250a3e

Suggest opening help instead of listing commands

lleo committed 8 years ago
Verified
af4705c062eb0b22c1641d584fb5161393e6578e

Removed command line indicators

lleo committed 8 years ago
Verified
644991ec47160ba6084ed93d498d99bda0ed1f20

Also no need for Gitter anymore

lleo committed 8 years ago

README

The README file for this repository.

cory

Build Status XO code style


IMPORTANT: This project is deprecated. Please go with next.js!


Ever wanted to create a static site while taking advantage of all the amazing things that are available within the JavaScript universe? Then you're at the right place!

Cory combines clean, logic-less handlebars templates and markdown files with a straightforward development workflow and allows you to set up a new site in a few seconds.

Usage

Install it (you'll need at least v6 of Node):

npm install -g cory

Run it:

cory [options] [command]

Theres a list of all options and commands below. For a step-by-step guide, check this out.

Contribute

Uninstall the package if it's already installed:

npm uninstall -g cory

Clone this repository:

git clone https://github.com/leo/cory.git
cd cory

Link it app to the global module directory:

npm link

Yeeha! 🐴 Now you can use the gulp command within the repository to transpile the its sourcefiles and watch for changes. While the command is running, you're able to use the cory command everywhere!

Commands & Options

Run the following command to get a list of all available options and commands:

cory help

Config

There are a few properties that can be changed by simply adding them to a config.json file within your project. The JSON object below shows all available options and their default value:

{
  "port": 4000, // See option "--port" (CLI option will overwrite this)
  "outputDir": "dist", // Path of the directory that will contain the generated site
  "sourceMaps": true, // Enable/disable the generation of sourcemaps for assets
  "defaultLayout": "main", // The default template into which all pages will be wrapped
  "assetDir": "assets" // Default name of the folder that contains the assets
}