Skip to content

The monorepo where all the Kickflip packages live at!

License

Notifications You must be signed in to change notification settings

KickflipCli/kickflip-src

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kickflip Site Builder

The monorepo for Kickflip site generator and the docs.

Source Code Download Package PHP Programming Language Read License Build Status Codecov Code Coverage Psalm Type Coverage

A message to Russian 🇷🇺 people

If you currently live in Russia, please read this message.

About

Kickflip is a Laravel Zero based CLI tool that generates a static HTML site from markdown and blade template files. This is the monorepo that houses the Kickflip-cli Site builder and the docs for it.

Repositories

  • kickflip-cli - The core Kickflip CLI project that provides the brains of Kickflip, kinda like laravel/framework
  • kickflip - The starter project for Kickflip, equivilent to laravel/laravel
  • kickflip-docs - The official documentation for Kickflip
  • kickflip-router-nav-plugin [DEPRECATED - Built-in as of 0.10] - The official plugin for Router/Nav features

Documentation

The official Kickflip Docs are at: https://kickflip.lucidinternets.com/

Warning

Until this repo reaches V1.0.0, this is a work in progress and it may will eat your cat.

Before V1 is released this repo may undergo a lot of changes with no backwards compatibility guarantees.

The Roadmap to V1

  • At least 80% test coverage complete
  • Full implement Pretty URL build flag
  • Complete the KickflipCLI docs repo
  • Review how URLs are generated by Helpers and such (should URLs be relative, or absolute? maybe make it a config option?)
  • Determine behavior for static files within sources (copy to build folder or consider better methods)
  • Explore idea about mocking traditional laravel routes based on source files (could allow for named routes usage 🤔)
  • Create a starter project
  • Sort out workflows for CHANGELOG.md updates
  • Add README.md files to Kickflip-cli and Kickflip-docs
  • Hook into NodeJS to ensure required dependencies are installed