Giter VIP home page Giter VIP logo

stenope's Introduction

Stenope

The static website generation tool for Symfony.

CLI

Why another static site generator?

We're Symfony developers that couldn't find a static website generator that bended to our needs.

We needed a way of generating static websites that:

  • Doesn't impose a format, a structure or a location for the data.
  • Runs in a Symfony environment.
  • Allow us to develop virtually any feature we might need.

Stenope does that.

Installation

In your existing Symfony app:

composer require stenope/stenope

If you plan to create a new app from scratch, you can give a try to the Stenope Skeleton.

Usage

bin/console -e prod cache:clear
bin/console -e prod stenope:build ./static

Your Symfony app is now a static website in: ./static! โœจ

Next: learn more about Stenope's content management system.

Philosophy and goals

Stenope was designed with these goals in mind:

  • Stenope meets your needs, not the other way around.
  • Stenope runs in any Symfony project out of the box, connects with standard Symfony components and feels natural to Symfony developers.
  • Stenope is highly extensible: features can be replaced, added or removed.

How it works

  • ๐Ÿ” Stenope scans your Symfony app (like a search engine crawler would) and dumps every page into a static HTML file.
  • ๐Ÿ›  Stenope provides tools for loading and parsing various data sources (like local Markdown files or distant headless CMS).
  • ๐Ÿ–Œ Stenope enriches the parsed data by applying a series of processors (like Syntax Highlighting, slug generation, etc.).
  • ๐Ÿงฒ Stenope finally hydrates your custom PHP objects with the enriched data and provides interfaces for listing and retrieving them (like an ORM would).
  • โš™๏ธ Stenope gives you a lot of control over the whole process by providing entrypoints, interfaces and default implementations that are entirely replaceable.

What Stenope is not

Stenope is not a ready-to-use bloging system: but you could quickly write your own blog system with it!

In-depth documentation

Features

Cookbooks

stenope's People

Contributors

actions-user avatar arnaudligny avatar benji07 avatar dependabot[bot] avatar ogizanagi avatar tom32i avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.