Skip to content

Flutter-Bounty-Hunters/static_shock

Repository files navigation

Static Shock - A static site generator, written in Dart

Built by the Flutter Bounty Hunters


For documentation, visit staticshock.io

Quickstart

Generate a new Static Shock project with static_shock_cli:

# Activate the CLI tool.
dart pub global activate static_shock_cli

# Generate a new project.
shock create

Once you've created a project, you can (re)build your static site as needed:

# Build directly
dart bin/main.dart

# Or, build with the CLI tool
shock build

To demo your static site, run a local server from your project directory, using the CLI tool:

shock serve

The local server automatically rebuilds and reloads your pages as you work.

Packages

Packages in this repository:

  • /packages/static_shock_cli: project that implements the Static Shock CLI tool.
  • /packages/static_shock: the core of Static Shock, which builds static websites.
  • /packages/static_shock_docs: the website for Static Shock documentation.

Development

This repository is a mono-repo. To work with it, you need Melos available on your path:

dart pub global activate melos

When you first open the root of the project for development, bootstrap Melos:

melos bootstrap