You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
HerrHase
918c0896e7
|
2 years ago | |
---|---|---|
example | 2 years ago | |
src | 2 years ago | |
.gitignore | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 2 years ago | |
index.js | 2 years ago | |
package-lock.json | 2 years ago | |
package.json | 2 years ago | |
test.js | 2 years ago |
README.md
Site-O-Mat Webpack Plugin
A Webpack Plugin for generating a Website as Html-Files from a Markdown File Structure.
Why? The Main reason i had to update some Websites, but realise there were no benfit to use a Full CMS or Headless CMS like Directus. Rendering the same pages that a rarley updated seems like a waste of energy. Why not generate from a hierachical file structure. Luckly i i had development a CMS that runs on Markdown File a few years ago as a proof of concept.
Roadmap
Next will be,
- Some tests
- Integrate Eta.js and LiquidJS
Installation
Setup this registry in your project .npmrc file:
@helpers:registry=https://gitea.node001.net/api/packages/HerrHase/npm/
Install with npm or yarn
npm i --save-dev @helpers/siteomat-webpack-plugin
yarn add --dev @helpers/siteomat-webpack-plugin
Configuration
const SiteomatWebpackPlugin = require('siteomat-webpack-plugin')
plugins: [
new SiteomatWebpackPlugin(
'./resources/site',
'./resources/views'
)
]
or
plugins: [
new SiteomatWebpackPlugin(
'./resources/site',
'./resources/views',
{
<options>
}
)
]
Name | Type | Default | Description |
---|---|---|---|
destination | {String} | null | If not set, it will use the public path |
htmlMinify | {Boolean} | true | Minify Html and remove all Whitespace |
Pages
---
title: "health goth DIY tattooed"
view: "home.njk"
meta:
description: "La"
media:
teaser:
src: "_images/test.jpeg"
alt: "cold-pressed"
---
Blocks
"_blocks" in a Directory.
Find
Basic Usage:
pageQuery.find()
or with options,
Name | Type | Default | Description |
---|---|---|---|
parent | {String} | / | |
deep | {Integer} | -1 | |
orderBy | {Array} | null |