GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - codebase-io/unscrew: Markdown-to-JSON headless CMS

BranchesTags
Open more actions menu

Latest commit

 

History

23 Commits
23 Commits

Folders and files

NameName
Last commit message
Last commit date
public
public
 
 
src
src
 
 
storage
storage
 
 
tests
tests
 
 
.gitignore
.gitignore
 
 
Makefile
Makefile
 
 
Readme.md
Readme.md
 
 
Todos.md
Todos.md
 
 
bootstrap.php
bootstrap.php
 
 
compose.yml
compose.yml
 
 
composer.json
composer.json
 
 
config.dist.php
config.dist.php
 
 

Repository files navigation

Unscrew

Markdown-to-JSON headless CMS

Built atop symfony/http, league/commonmark and league/flysystem, Unscrew is your bare-bones hackable JSON API in front of your Markdown files. Although it's main purpose is to expose JSON, you thanks to the powerful commonmark library, you can serve HTML too.

Reasons

The best reason probably is that you can decouple the content from the publishing platform.

Installation

composer create-project unscrew/project unscrew
cd unscrew
docker compose up -d

Open http://localhost:1888/ . The default composer stack uses Apache, with the config file located under public/apache2.conf.

Configuration

The configuration options are stored in config.php. Here you'll see we create a commonmark parser object and filesystem adapter to be used when parsing and locating files. You can use any of the flysytem adapters (s3/ftp/box/azure/dropbox):

  • defaultFormat: the format to parse Markdown files to. json, html or md.

Routing

Customization

Parsing

Parsing markdown it usually done to HTML. However, when it comes to JSON there's a much higher coupling with the code consuming it. So don't settle for the default collection of parsers, and don't hesitate to implement your own.

The parser's interface only requirement is the parse(string $filename) method:

interface ParserInterface
{
    public function parse(stream, ?string $documentRoot=NULL, ?string $documentId=NULL): array;
}

Check the list of available parsers (// TODO)

About

Markdown-to-JSON headless CMS

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.