Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ianrose/machinist
An opinionated boilerplate for Metalsmith.
https://github.com/ianrose/machinist
google-docs metalsmith static-site
Last synced: about 2 months ago
JSON representation
An opinionated boilerplate for Metalsmith.
- Host: GitHub
- URL: https://github.com/ianrose/machinist
- Owner: ianrose
- License: mit
- Created: 2016-08-26T12:08:16.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T20:06:57.000Z (about 2 years ago)
- Last Synced: 2024-10-29T04:20:46.259Z (3 months ago)
- Topics: google-docs, metalsmith, static-site
- Language: HTML
- Homepage:
- Size: 549 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://raw.githubusercontent.com/ianrose/machinist/master/LICENSE)
# Machinist
An opinionated boilerplate for a [Metalsmith](http://www.metalsmith.io/) static site.
- [Handlebars](http://handlebarsjs.com/)
- [StandardJS](https://github.com/feross/standard)
- [Sass](https://github.com/sass/sass)
- [Stylelint Standard](https://github.com/stylelint/stylelint-config-standard)
- [Webpack](https://github.com/christophercliff/metalsmith-webpack)
- [Autoprefixer](https://github.com/postcss/autoprefixer)
- [HTMLHint](https://github.com/yaniswang/HTMLHint)
- [Editorconfig](http://editorconfig.org/)
## Features
- Add structured data globally in JSON or YAML in the `./src/globaldata/`
- Add structured data to a specific Markdown file by adding in the frontmatter `model: file_name.json`, with `file_name.json` living in `./src/models/`
## Requirements
[node.js](https://nodejs.org/en/)
## How to Setup
### 1. Clone
```
git clone https://github.com/ianrose/machinist.git
```
### 2. Install Dependencies
```
$ npm install
```
### 3. Configure Project
Edit the `./config.json` as you see fit.
```json
{
"name": "Person or Org",
"title": "Global Title",
"titleSeperator": "|",
"domain": "blank.org",
"url": "http://blank.org",
"description": "Global Description",
"keywords": null,
"dest": "./www/",
"src": "./src/",
"assetPath": {
"development": "/",
"stage": "/",
"production": "/"
},
"googleVerification": null,
"analytics": {
"provider": false,
"google": {
"trackingId": "GA-######"
}
},
"twitter": {
"username": "@username"
},
"facebook": {
"username": null,
"appId": null,
"publisher": null
},
"openGraph": {
"image": null
},
"googleDocJson": {
"fileId": null,
"output": "./src/data/models/archieExample.json"
}
}
```
## How to use
### Develop
Runs your project locally at `localhost:3000` with BrowserSync. Edit contents of `./layouts`, `./lib`, `./partials`, and `./src`.
```
npm run dev
```
Develop with Metalsmith debugging.
```
npm run debug
```
### Build
Generates your dist to be deployed in the folder `./www`.
```
npm run build
```
### Lint
Lints your styles, scripts, and markup.
```
npm run lint
```
### Format
Fix lint errors in your styles and scripts.
```
npm run format
```