Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

101 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Workflow Status

Sandbox cli

This is an opinionated static site generator built with speed of development in mind.

This is very cutting edge software and should not be used in production yet as the API is subject to change in the near future.

Install

  1. Get the library
npm install @jverneaut/sandbox
  1. Add a pages folder with at least a index.md, index.js and index.twig files in this directory
mkdir pages
touch index.md index.twig index.js
  1. Add a frontmatter to the index.md file to specify its title
---
title: Example
---
  1. Add a dev and build script to your project
 "scripts": {
    "dev": "sandbox dev",
    "build": "sandbox build"
  },

TODO

  • Improve the markdown rendering/remove the \" from the html and link attributes
  • Allow more customization of the markdown, webpack and site configuration
  • Create a documentation site
  • Find a more memorable name
  • Better handle client-side webpack errors
  • Allow images in markdown documents
  • Setup the GitHub repository to allow contributions
  • Setup a test suite

About

[In development] - An opinionated static site generator built with speed of development in mind.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages