https://github.com/cuttlebelle/cuttlebelle
The react static site generator that separates editing and code concerns
https://github.com/cuttlebelle/cuttlebelle
content-management nodejs rapid-prototyping react reactjs static-site-generator
Last synced: about 2 months ago
JSON representation
The react static site generator that separates editing and code concerns
- Host: GitHub
- URL: https://github.com/cuttlebelle/cuttlebelle
- Owner: cuttlebelle
- License: gpl-3.0
- Created: 2017-06-08T01:23:04.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T14:37:12.000Z (about 2 years ago)
- Last Synced: 2024-04-14T13:10:02.324Z (about 1 year ago)
- Topics: content-management, nodejs, rapid-prototyping, react, reactjs, static-site-generator
- Language: HTML
- Homepage: https://cuttlebelle.com/
- Size: 4.41 MB
- Stars: 545
- Watchers: 15
- Forks: 28
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - cuttlebelle/cuttlebelle - The react static site generator that separates editing and code concerns (HTML)
README
Cuttlebelle
[](https://travis-ci.org/cuttlebelle/cuttlebelle)
[](https://twitter.com/intent/tweet?url=https://cuttlebelle.com&hashtags=react,reactjs,static-site-generator,jsx)
===========
**
The react static site generator with editing in mind
**
##
[Visit our website](https://cuttlebelle.com/)
[](https://cuttlebelle.com/)
## 🔥 Why yet another static site generator?
All static site generators I have used restrict you to use one layout per page. Todays webdesign needs have outgrown this and we often find ourself either
adding code into our content pages (markdown files, liquid templates) or content into our code.
That makes updating and maintaining a page hard, especially for a non-technical content author.
I needed a generator that can **separate content from code** as cleanly as possible while still staying a static site generator and as dynamic as possible.
[React](https://facebook.github.io/react/) comes with the component paradigm and was exactly what I’m looking for.
[JSX](https://facebook.github.io/react/docs/introducing-jsx.html) enables a very easy templating like way to write components while still keeping the power of
javascript. **No more templating languages** that only do half of what you need. Use javascript to write your layouts.
## Contents
* [Install](#install)
* [Requirements](#requirements)
* [Getting started](#getting-started)
* [Usage](#usage)
* [Self-documenting](#self-documenting)
* [Build](#build)
* [Tests](#tests)
* [Release History](#release-history)
* [License](#license)
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Requirements
To use Cuttlebelle you need at least node `>= 12`.
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Install
```shell
npm install cuttlebelle -g
```
Then run `cuttlebelle` in your working folder.
💡Tip: I recommend [installing](#install) Cuttlebelle globally as it exposes the `cuttlebelle` command to your system.
If you for some reason want to install it locally, consider adding a npm script to your `package.json` to make
running cuttlebelle easier:
```diff
{
"name": "your name",
"version": "1.0.0",
"description": "Your description",
"main": "index.js",
"scripts": {
+ "build": "cuttlebelle",
+ "watch": "cuttlebelle -w",
"test": "echo \"Error: no test specified\" && exit 1"
},
"devDependencies": {
"cuttlebelle": "^1.0.0"
}
"keywords": [],
"author": "",
"license": "ISC"
}
```
Then run `npm run build` to run cuttlebelle.
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Getting started
After [installing](#install) cuttlebelle, create a folders called `content` and `code` and start populating them.
Each folder with an `index.yml` file will become an `index.html` in cuttlebelles generated pages.
Your content folder
Output
```shell
.
├── index
│ ├── index.yml
│ ├── partial1.md
│ └── partial2.md
├── page1
│ ├── index.yml
│ └── subpage1
│ ├── index.yml
│ ├── partial1.md
│ └── partial2.md
├── page2
│ ├── index.yml
│ ├── partial1.md
│ └── partial2.md
└── shared
├── component1.md
└── component2.md
```
→
```shell
.
├── index.html
├── page1
│ ├── index.html
│ └── subpage1
│ └── index.html
└── page2
└── index.html
```
Consider this example to see how pages are constructed with partials and layouts:
An **index.yaml** page
index.yml
page layout
```yaml
layout: page
title: Homepage
main:
- header.md
- body.md
```
+
```jsx
import React from "react";
export default ({ title, main }) => (
{ title }
{ main }
);
```
A **header.md** partial
partial header.md
header layout
```markdown
---
layout: header
headline: First post
sub: Clear content separation
---
```
+
```jsx
import React from "react";
export default ({ headline, sub }) => (
{ headline }
{
sub
&& { sub }
}
);
```
A **body.md** partial
partial body.md
body layout
```markdown
---
layout: body
headline: First post
---
**Hello world**
```
+
```jsx
import React from "react";
export default ({ _body, headline }) => (
{ headline }
{ _body }
);
```
Will give us this HTML
resulting static HTML file
```html
Homepage
First post
Clear content separation
First post
Hello world
```
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Usage
* [CLI](#cli)
* [Your content](#your-content)
* [Your assets](#your-assets)
* [Your layout](#your-layout)
* [Customizations](#customizations)
### CLI
```shell
cuttlebelle
```
This will generate all pages into the `site` folder _(unless [specified otherwise](#customizations))_.
#### Init
For when you’re just starting out on a new project use the `init` option. It will generate the folder structure for you and add some files for you to get
started quickly.
```shell
cuttlebelle init
```
#### Watch
You can also run the highly optimized watch while adding content or developing your layouts.
```
cuttlebelle watch
```
This command will first build your pages and then watch for changes in any of them.
It will dutifully only build the absolute minimum of pages once it detects a change somewhere. It is so eager to only build those pages that it thinks are
relevant that it misses sometimes. In cases where you add content from the `_pages` prop in one of your layouts for instance. I have added a new and somewhat
genius trick to catch cases like that.
**Introducing the _double save_** TM
If you feel like the watch may have missed a page and you don’t want to leave your editor to complain about it to the watch, just save your file twice quickly
like a double click. The watch will detect the _double save_TM and generate all pages for you again.
💡Tip: You can change the timeout of the watch to detect a double save via the `watchTimeout` [setting](#customizations).
#### Watch flags
##### No generator flag
Sometimes you may only want to start a watch and not rebuild all pages. For that use the `no-generate` option:
```shell
cuttlebelle watch --no-generate
```
##### Silent flag
The watch notifies you each time it encounters an error so you don’t have to watch the watch. You can disable that behavior via the silent option.
```shell
cuttlebelle watch --silent
```
#### Docs
Cuttlebelle comes with a nifty feature that will auto-document your layouts if you use the right propTypes and comments.
Read more about how in the [self documenting](#self-documenting) section.
```shell
cuttlebelle docs
```
#### Version
To display the version of your cuttlebelle install all you have to do is run the version flag:
```shell
cuttlebelle --version
```
#### Help
Of course there is also a help option. Just run it with the help flag:
```shell
cuttlebelle help
```
**[↑ back to Usage](#usage)**
### Your content
The default folder structure divides content into the `content/` folder and the layout and component react files into the `code/` folder.
```shell
.
├── content/ # The content folder
│ ├── page1/ # Each folder represents a page and will be converted to `page1/index.html`
│ │ # 💡 As long as it contains an `index.yml` file.
│ │
│ ├── index/ # The index folder is treated as the homepage and converted to `/index.html`
│ │
│ └── page2/ # You can nest pages by nesting them in the folder structure
│ │
│ └── subpage1/ # As long as this folder has an `index.yml` file
│ # it will be converted to `page2/subpage1/index.html`
│
├── assets/ # The assets folder, every file you add here will be moved to your output.
└── code/ # The `code` folder is where your layout lives
```
_(_ 💡 _All folders can be configured in your `package.json` file via the [cuttlebelle customizations](#customizations).)_
Now let’s look into one folder:
```shell
.
└── content
├── page1
│ ├── index.yml # This folder includes an `index.yml` file so it will be converted into
│ │ # a page in the output of cuttlebelle.
│ ├── partial1.md # The partials are all in markdown format and can have any name.
│ └── partial2.md # You can reference partials from your index.yml or another partial.
│
└── shared # A folder won’t be generated if it doesn’t have an `index.yml` file
├── component1.md # You can use such folders to share partials between pages
└── component2.md # This is just a suggestion. Partials can live anywhere.
```
#### Your `index.yml`
A typical `index.yml` file could look like this:
```yaml
layout: page # The layout of an `index.yml` defaults to `page` if it’s not set
title: Homepage # It’s always a good idea to give your page a title
main: # Defining an array in yaml
- feature-image.md # This is a partial (because it ends with ".md") and points to a markdown
# file that exists
- cta.md
- contact-cards.md
- /shared/footer.md # This is also a partial but because it starts with a slash "/" the
# location where this partial sits is relative to your content folder
# and not the page folder you’re in.
header: header.md # You can define a partial to a variable or to an array as seen above
content: Hello world # Or you can put any type of string into your yaml if you prefer.
```
_(_ 💡 _All variables that are defined inside a page are available as props under `{ _pages }` to all partials.)_
#### Your partials
And a typical `partial.md` file could look like this:
```markdown
--- # Each markdown file can have frontmatter
layout: cards # The power of cuttlebelle is each partial has it’s own layout
# The layout of partials defaults to `partial` if it’s not set
headline: Partial headline # You can add any number of variables
cards: # Even arrays
- id: ID1 # Or objects
title: Card1
content: content for first card
- id: ID2
title: Card2
content: content for second card
---
Content
```
_(_ 💡 _Of course all variables are again available as props to the layout by their own name.)_
**[↑ back to Usage](#usage)**
### Your assets
All files included inside the `assets/` folder are moved to `site/assets/`. This is where you should keep your CSS, SVGs and images.
Just create a prop inside your `index.yml` pages to include them into your pages:
`content/index/index.yml`:
```yaml
layout: layout/homepage
title: Homepage
stylesheet: homepage
main:
- /shared/header.md
- homepage.md
- /shared/footer.md
aside:
- nav.md
- callout.md
```
`code/layout/homepage.js`
```jsx
import React from "react";
export default ({ title, stylesheet, title, main, aside }) => (
{ title }
{ stylesheet != undefined
? ( )
: null
}
{ title }
{ main }
{ aside }
);
```
`/assets/homepage.css`
```css
main {
background: rebeccapurple;
}
aside {
background: hotpink;
}
```
**[↑ back to Usage](#usage)**
### Your layout
The layout are all [react](https://facebook.github.io/react/) components. You have to assign a layout to each page and partial. Each component will have a
bunch of props exposed to it.
#### A page layout
A typical component for a page might look like this:
```jsx
import React from "react";
export default ({ title, partials }) => (
{ title }
{ title }
{ partials }
);
```
#### A partial layout
A typical component for a partial might look like this:
```jsx
import React from "react";
export default ({ _body, title }) => (
{ title }
{ _body }
);
```
_(_ 💡 _You can access the page your partial was called in via: `props._pages[ props._ID ]`.)_
#### Props
A file will receive the following props:
| prop name | description | Example |
|----------------|---------------------------------------------------------------------------------------|-----------------------------------------------|
| `_ID` | The ID of the current page | `props._ID` |
| `_self` | The relative path to the content file; can be md or yaml file | `props._self` |
| `_isDocs` | A boolean value, `true` in docs context only | `props._isDocs` |
| `_parents` | An array of all parent pages IDs | `props._parents` |
| `_body` | The body of your markdown file (empty for `index.yml` files) | `props._body` |
| `_pages` | An object of all pages and their props; with ID as key | `props._pages.map()` |
| `_nav` | A nested object of your site structure | `Object.keys( props._nav ).map()` |
| `_globalProp` | A prop that can be set globally from the `package.json` | `props._globalProp` |
| `_storeSet` | You can set data to persist between react components by setting them with this helper | `props._storeSet({ variable: "value" })` |
| `_store` | To get that data just call this prop function | `props._store()` |
| `_relativeURL` | A helper function to make an absolute URL relative | `props._relativeURL( URL, yourLocation )` |
| `_parseMD` | A helper function to parse markdown into HTML | `props._parseMD('Your **markdown**!')` |
| `_parseYaml` | A helper function to parse yaml into an object | `props._parseYaml('test:\n - one\n - two')` |
| `_parseReact` | A helper function to parse a react component into a string | `props._parseReact( )` |
Plus all other variables declared inside the file either as `frontmatter` or in the `yaml` files.
#### Async data fetching
If you require data from an API or some other async operations you can use the static `getInitialProps` method in your component:
```jsx
import React, { Component } from 'react';
class GetData extends Component {
static async getInitialProps( props ) {
const data = await FetchMyDataFromSomewhere( props._ID );
return { data };
}
render() {
return (
My Data: { this.props.data }
);
}
}
export default GetData;
```
`getInitialProps` will be executed before we render the HTML and whatever you return from it will be passed into your react component as a prop.
The function will have access to all props of that partial as well.
_(_ 💡 _Make sure you return an object so that you can find your prop again.)_
**[↑ back to Usage](#usage)**
### Customizations
Cuttlebelle can be customized via your own `package.json` file.
_(_ 💡 _You can generate it via `npm init` if you don’t have `package.json`.)_
See below all configuration with default values:
```diff
{
"name": "your name",
"version": "1.0.0",
"description": "Your description",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
+ "cuttlebelle": {
+ "folder": {
+ "content": "/content/",
+ "code": "/code/",
+ "site": "/site/",
+ "docs": "/docs/",
+ "assets": "/assets/",
+ "index": "index",
+ "homepage": "index"
+ },
+ "layouts": {
+ "page": "page",
+ "partial": "partial"
+ },
+ "site": {
+ "root": "/",
+ "doctype": "",
+ "redirectReact": true,
+ "markdownRenderer": "",
+ "watchTimeout": 400,
+ "browserSync": {},
+ "globalProp": {},
+ },
+ "docs": {
+ "root": "files/",
+ "index": ".template/docs/layout/index.js",
+ "category": ".template/docs/layout/category.js",
+ "IDProp": "page2",
+ "navProp": {},
+ "pagesProp": {}
+ }
+ },
"keywords": [],
"author": "",
"license": "ISC"
}
```
A breakdown:
```js
"cuttlebelle": { // The cuttlebelle object
"folder": { // Where we can adjust folder/file names
"content": "content/", // Where does your content live?
"code": "code/", // Where do your react layouts live?
"assets": "assets/", // Where do your assets live?
"site": "site/", // Where do you want to generate your static site to?
"docs": "docs", // Where do you want to generate the docs to?
"index": "index", // What is the name of the file we look for to generate pages?
"homepage": "index" // What should the index folder be named?
},
"layouts": { // Your layout settings
"page": "page", // What is the default layout for pages?
"partial": "partial" // What is the default layout for partials?
},
"site": { // General settings
"root": "/", // What should cuttlebelle append to links?
"doctype": "", // What doctype string do you want to add?
"redirectReact": true, // You can disable redirecting `import` calls to the locally
// installed react instance of cuttlebelle rather than your
// local folder.
"markdownRenderer": "", // A path to a file that `module.exports` an Marked.Renderer()
// object. Learn more about it here:
// https://github.com/chjj/marked#renderer
// The only addition is the `preparse` key that will be run
// before we go into the markdown parsing
"watchTimeout": 400, // This is the time in milliseconds the watch waits
// to detect a double saves action
"browserSync": {}, // You can overwrite the browserSync options here
// https://www.browsersync.io/docs/options
"globalProp": {} // A global prop that can be set here accessible for all pages
},
"docs": { // Docs settings
"root": "files/", // What is the root folder called where all
// categories are generated in
"index": ".template/docs/layout/index.js", // The path to the index layout file
"category": ".template/docs/layout/category.js", // The path to the category layout file
// All following settings are the default props
// each component is given for the example
// The following props are important so we
// can generate the docs example:
"IDProp": "page2", // The _ID prop
"selfProp": "body.md", // The _self prop
"navProp": { // The _nav prop
"index": {
"page1": "page1",
"page2": {
"page2/nested": "page2/nested"
},
"page3": "page3"
}
},
"pagesProp": { // The _pages prop
"page1": {
"_url": "/page1",
"title": "Page 1"
},
"page2": {
"_url": "/page2",
"title": "Page 2"
},
"page2/nested": {
"_url": "/page2/nested",
"title": "Nested in page 2"
},
"page3": {
"_url": "/page3",
"title": "Page 3"
},
"index": {
"_url": "/",
"title": "Homepage"
}
}
}
}
```
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Self-documenting
Because you now can separate the content flow from the development flow you will still need to communicate what partials and layouts the content authors have
to their disposal and how they might use it.
Cuttlebelle has a built in feature that will generate documentation for your components automatically as long as you use
[PropTypes](https://facebook.github.io/react/docs/typechecking-with-proptypes.html) and a comment above them that reflects the `yaml`.
```jsx
Cards.propTypes = {
/**
* level: "2"
*/
level: PropTypes.oneOf([ '1', '2', '3', '4', '5', '6' ]).isRequired,
/**
* hero: true
*/
hero: PropTypes.bool,
/**
* cards:
* - title: Card 1
* content: Content for card 1
* href: http://link/to
* - title: Card 2
* content: Content for card 2
* href: http://link/to
* - title: Card 3
* content: Content for card 3
* href: http://link/to
* - title: Card 4
* content: Content for card 4
* href: http://link/to
*/
cards: PropTypes.arrayOf(
PropTypes.shape({
title: PropTypes.string.isRequired,
content: PropTypes.string.isRequired,
href: PropTypes.string,
})
).isRequired,
};
```
You can also hide a component from the docs by adding the `@disable-docs` to the main comment before declaring your component:
```jsx
import PropTypes from 'prop-types';
import React from "react";
/**
* Hiding this component from the docs
*
* @disable-docs
*/
const Hidden = ({ _body, title }) => (
{ title }
{ _body }
);
Hidden.propTypes = {
/**
* title: Welcome
*/
title: PropTypes.string.isRequired,
/**
* _body: (text)(7)
*/
_body: PropTypes.node.isRequired,
};
export default Hidden;
```
Once all your components have those comments cuttlebelle can generate the docs for you. All you have to do it run:
```shell
cuttlebelle docs
```
The docs will be generated by default in the `docs/` folder of your project.
### Supported PropTypes
- PropTypes.array
- PropTypes.bool
- PropTypes.number
- PropTypes.object
- PropTypes.string
- PropTypes.node
- PropTypes.element
- PropTypes.oneOfType
- PropTypes.arrayOf
- PropTypes.objectOf
- PropTypes.shape
- PropTypes.any
### PropTypes that can’t be passed with YAML
- PropTypes.func
- PropTypes.symbol
- PropTypes.instanceOf
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Build
**We use Yarn on this project to ensure deterministic builds across node versions**
To contribute to this still young project you need to install it’s dependencies and run a watch to transpile the files.
```shell
yarn install
yarn run watch
```
_(_ 💡 _Please look at the coding style and work with it, not against it :smile:.)_
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Tests
Cuttlebelle is being automatically tested on the below systems and node versions.
https://travis-ci.org/cuttlebelle/cuttlebelle.svg?branch=master
| OS | Node version | Node version | Node version |
|-----------|--------------|--------------|--------------|
| `Linux` | `~8` | `~10` | `~12` |
| `OSX` | `~8` | `~10` | `~12` |
I got an [end-to-end test script](https://github.com/cuttlebelle/cuttlebelle/blob/master/tests/tester.js) that compares fixtures to what cuttlebelle
generates. In each of those folders I test for [specific things](https://github.com/cuttlebelle/cuttlebelle/blob/master/tests/tester.js#L30) and make sure
the checksum of the generated files match the fixtures. In addition to that I created as many
[unit tests](https://github.com/cuttlebelle/cuttlebelle/tree/master/tests/__unit__) as I can via [Jest](https://facebook.github.io/jest/).
[Flow](https://flow.org/) types are also checked where they are specified.
- `yarn run test` to run all tests
- `yarn run test:end-to-end` will run the end-to-end test only
- `yarn run test:unit-test` will run the unit test only
- `yarn run test:flow` will run the flow type test
- `yarn run test:detail` will give you coverage infos for the unit tests
- `yarn run test:watch` will spin up the jest watch
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Release History
See [CHANGELOG](https://github.com/cuttlebelle/cuttlebelle/blob/master/CHANGELOG.md).
**[⬆ back to top](#contents)**
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## License
Copyright (c) Dominik Wilkowski. Licensed under [GNU-GPLv3](https://raw.githubusercontent.com/cuttlebelle/cuttlebelle/master/LICENSE).
**[⬆ back to top](#contents)**
# };