Miss any of our Open RFC calls?Watch the recordings here! »

ploceus

0.0.6 • Public • Published

Ploceus

Ploceus (weaver birds) are named for their elaborately woven nests. --- Wikipedia

Ploceus is a static site generator that helps you focus on content writing 📖 and style 💄 changing in a easy & rapid way.

Usage

Install it first

npm install -g ploceus
# Or with yarn 
yarn global add ploceus

To start build your website, you need to create a work space folder that contains content and theme. Check here for a simple example, it could also be your site template.

Check out project structure for detailed file organization. Then, start the development server and create you site!

cd <PROJECT_NAME>
ploceus dev

Finally, when you are going to build and deploy the site, use:

ploceus build -p
# -p stands for production 

You should see your site been built in the dist folder.

Command Line Arguments

$ ploceus build -h

build a site.

USAGE
  $ ploceus build [CONTENT] [THEME] [DIST]

ARGUMENTS
  CONTENT  [default: ./content] content folder
  THEME    [default: ./theme] theme folder
  DIST     [default: ./dist] dist folder

OPTIONS
  -h, --help        show CLI help
  -p, --production  enable production optimization during build.

EXAMPLE
  $ ploceus build
$ ploceus dev -h
watch file changes and rebuild. Also start a dev server.

USAGE
  $ ploceus dev [CONTENT] [THEME] [DIST]

ARGUMENTS
  CONTENT  [default: ./content] content folder
  THEME    [default: ./theme] theme folder
  DIST     [default: ./dist] dist folder

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ ploceus dev

API

You can use Ploceus as a normal npm package as well.

const { Ploceus } = require('ploceus')
 
const p = new Ploceus({
  contentPath: './content',
  themePath: './theme',
  distPath: './dist',
  production: false
})
 
p.build()
 
// Watch will only not start a dev server like the command line behavior!
// If you need it, we recommend you use a 3rd package like the browser-sync
p.watch()

Keywords

none

Install

npm i [email protected]

Version

0.0.6

License

MIT

Unpacked Size

43.7 kB

Total Files

40

Last publish

Collaborators

  • avatar