Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nju33/diz
:fork_and_knife: A static site generator with SSR
https://github.com/nju33/diz
blog build diz javascript markdown static-site-generator webpack2
Last synced: 16 days ago
JSON representation
:fork_and_knife: A static site generator with SSR
- Host: GitHub
- URL: https://github.com/nju33/diz
- Owner: nju33
- License: mit
- Created: 2016-08-24T15:11:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-31T05:47:18.000Z (almost 8 years ago)
- Last Synced: 2024-11-15T01:40:04.993Z (about 1 month ago)
- Topics: blog, build, diz, javascript, markdown, static-site-generator, webpack2
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/diz
- Size: 1.03 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
A static site generator.
[](https://travis-ci.org/nju33/diz) [](https://github.com/sindresorhus/xo) 
## Install
```bash
$ yarn add -D diz gulp
$ npm i -D diz gulp
```
## Example
```js
Diz.load({base: 'relative/path/'}).then(roots => {
const renderer = new Diz({roots});
// .html etc
renderer.render().pipe(gulp.dest('example/dist/'));
// .js using webpack
renderer.bundle().then(stream => {
stream.pipe(gulp.dest('example/dist/'));
});
});
```
## File organization
The directory at the level one level below **root path** is recognized as root.
However, in order to be processed, it is necessary to put config.js directly under the root directory.
```
└─
│ // blog1 is processed
├─
│ ├─ 0_getting-started.md
│ ├─ 1_hello-world.md
│ ├─ n_***.md
│ ├─ config.js
│
│ // blog2 isn't processed because there is no config.js
├─
│ ├─ 0_getting-started.md
│ ├─ 1_hello-world.md
│ ├─ n_***.md
├─ <...>
```
In `config.js`, describe meta information about the site, theme information, compilation method and so on. Also, the string up to `_` in each .md file is removed. It just uses to adjust the order of post files.
For example, it will be like this.
```js
const Renderer = require('diz-theme-xxxx');
const Plugin = require('diz-plugin-yyy');
const marked = require('marked');
module.exports = {
//* required
title: 'blog title',
url: 'http://blog.com/',
//* option
description: 'blog description',
author: 'nju33',
//* option
// Whether to reverse the order of n_*.md files
reverse: false
//* option
// When parent directory name is specified,
// the following happens
//
// 1. Inherit config.js of the specified directory
// 2. Becomes part of the blog of the specified directory
//
parent: '...'
//* option
// Overwrite inherited config
override: {...}
//* required
theme: {
//* required
// The theme itself (.jsx etc)
Renderer,
//* option
// Theme's config
config: {}
},
//* option
// Md file conversion function
// (contents: string): string
compile: marked,
//* option
// Array of used plugins
plugins: [new Plugin()]
};
```
The config data changes depending on the plugin and theme you are using.
## CLI
- `diz generate id`
Generate urn id
- `diz generate date`
Generate just date
## Themes
- [Minimalist](https://github.com/nju33/diz-theme-minimalist)
### How to create a theme
1. Install [diz-theme](https://github.com/nju33/diz-theme)
2. use it in parent class (e.g.) `class extends DizTheme`
For more information, click [here](https://github.com/nju33/diz-theme#readme)
## Plugins
- [collection page generator](https://github.com/nju33/diz-plugin-collection-page-generator)
Create a list pages
- [atom feed](https://github.com/nju33/diz-plugin-atom-feed)
Create atom feed
- [ref](https://github.com/nju33/diz-plugin-ref)
Override post.url
## License
The MIT License (MIT)
Copyright (c) 2016 nju33