https://github.com/ninjasort/metalpress
Create a blog easily with Metalsmith.
https://github.com/ninjasort/metalpress
cli liquid metalsmith static-site-generator webpack website
Last synced: 5 months ago
JSON representation
Create a blog easily with Metalsmith.
- Host: GitHub
- URL: https://github.com/ninjasort/metalpress
- Owner: ninjasort
- License: gpl-3.0
- Created: 2016-04-06T23:59:10.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-23T20:46:41.000Z (over 8 years ago)
- Last Synced: 2024-04-24T07:22:57.325Z (about 1 year ago)
- Topics: cli, liquid, metalsmith, static-site-generator, webpack, website
- Language: JavaScript
- Size: 345 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# metalpress [](https://www.npmjs.com/package/metalpress) [](https://travis-ci.org/axisdefined/metalpress) [](https://codecov.io/gh/axisdefined/metalpress)
> Create a blog easily with Metalsmith.
A wrapper of Metalsmith plugins for quickly creating a blog with [Metalsmith](https://github.com/metalsmith/metalsmith).
## Features
- Liquid Templating
- Markdown Rendering
- Permalinks
- Pagination
- Firebase Data Integration
- Webpack Bundling
- Use NPM Modules
- SASS Compiling and CSS Fingerprinting
- RSS & Sitemap Support
- Imagemin, Code Highlighting, Html Minification
- robots.txt
- Post Features
- Excerpts
- Tags
- Drafts
## Installation
```sh
$ npm install metalpress --save
```
## Structure and Templating
metalpress works from a specific directory structure. It contains a `templates` and `src` directory. Within the src directory it will load data from `data` as `yaml` or `json` files. You can create folders for collections and use markdown files for pages. You should store all assets in `assets`.
For templating, metalpress uses liquid. You can learn more about the [syntax here](https://github.com/leizongmin/tinyliquid).
Here's an example structure:
```sh
├── package.json
├── src
│ ├── data
│ ├── site.yaml
│ ├── projects.json
│ ├── assets
│ ├── sass
│ ├── img
│ ├── fonts
│ ├── js
│ ├── index.js
│ ├── index.md
│ ├── pages
│ ├── about.md
│ └── posts
│ ├── 2016-08-25-how-to-use-metalpress.md
├── templates
│ ├── _includes
│ ├── header.liquid
│ ├── footer.liquid
│ └── _layouts
│ ├── home.liquid
```
## Usage
To get started with metalpress, you can use the API or [CLI](https://github.com/axisdefined/metalpress-cli).
### API Usage
metalpress taks a [config](https://github.com/axisdefined/metalpress/wiki/Default-Config) object and callback. It will process the files in the config, build the site, and return a metalsmith instance. The callback will contain any errors and the file mappings.
```js
import metalpress from 'metalpress';
import config from './metalpress.config';
const m = metalpress(config, (err, files) => {
console.log('New site build completed.');
});
```
### CLI Usage
#### Install CLI
```sh
npm install metalpress-cli -g
```
#### Initialize a New Project
> Prompts a series of questions and creates a new `.metalpress` config.
```sh
metalpress init
```
#### Start a Browser-sync Server
> Serve the project on automatically assigned browser-sync port. (default: http://localhost:3000)
```sh
metalpress serve
```
#### Deploy a Project
To deploy your site, you'll need to have your `aws.json` set up. It includes:
```
{
"key":"AWS_ACCESS_KEY_HERE",
"secret":"AWS_SECRET_KEY_HERE",
"stagingBucket":"staging.example.com",
"productionBucket":"example.com"
}
```
> Deploy a `dist` and deployed to AWS S3.
*Staging*
```sh
metalpress deploy
```
*Production*
```sh
metalpress deploy -p
```
### Webpack Usage
By default, metalpress uses a webpack configuration for both staging and production environments. Within your config, you can specify `jquery: true` for included support jquery.
If you need to do so, you can override webpack with a custom config. For example, you can use the following options in your .metalpress config. You can add only the parameters you need which will be extended into the defaults, or override the entire file as needed.
```json
{
"webpack": {
"dev": "./webpack.config.js",
"prod": "./webpack.prod.config.js"
}
}
```
For Questions, Issues, PRs please refer to [@cameronroe](http://github.com/cameronroe)
[GPL-3 LICENSE](/LICENSE)