https://github.com/withsapling/sapling

A simple modern SSR-first framework for websites.
https://github.com/withsapling/sapling

browser deno javascript sapling server typescript

Last synced: 7 months ago
JSON representation

A simple modern SSR-first framework for websites.

• Host: GitHub
• URL: https://github.com/withsapling/sapling
• Owner: withsapling
• License: mit
• Created: 2024-10-24T15:53:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-19T22:28:45.000Z (about 1 year ago)
• Last Synced: 2024-11-19T22:44:17.735Z (about 1 year ago)
• Topics: browser, deno, javascript, sapling, server, typescript
• Language: TypeScript
• Homepage: https://sapling.build
• Size: 75.2 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![A Simpler Web Framework](.github/assets/gh-banner.jpg 'A Simpler Web Framework')

# Sapling

A Modern SSR framework for generating content-first websites. 

 - Multi-runtime, meaning you can use it with [Deno](https://deno.com/), [Node](https://nodejs.org/), [Bun](https://bun.sh/), and [Cloudflare Workers](https://developers.cloudflare.com/workers/). 

 - Support for Tailwind CSS via [UnoCSS](https://github.com/unocss/unocss).

 - Completely buildless meaning it has no build step and does not rely on a bundler.

## Getting Started  

Deno

```bash

deno -A jsr:@sapling/create

```

Node

```bash

npm create sapling@latest

```

Bun

```bash

bunx create-sapling@latest

```

## Packages

| Package | Description | Version |

|---------|-------------|-----|

| [sapling](./packages/sapling/) | A micro SSR framework | [![JSR](https://jsr.io/badges/@sapling/sapling)](https://jsr.io/@sapling/sapling) |

| [create](./packages/create/) | A CLI for creating Sapling projects | [![JSR](https://jsr.io/badges/@sapling/create)](https://jsr.io/@sapling/create) |

| [markdown](./packages/markdown/) | A markdown parser for Sapling sites or Deno projects | [![JSR](https://jsr.io/badges/@sapling/markdown)](https://jsr.io/@sapling/markdown) |

| [image](./packages/image/) | A powerful image optimization library | [![JSR](https://jsr.io/badges/@sapling/image)](https://jsr.io/@sapling/image) |

| [create-sapling](./packages/create-sapling/) | A CLI for creating Sapling projects with npm | [![npm](https://img.shields.io/npm/v/create-sapling.svg)](https://www.npmjs.com/package/create-sapling) |

| [sapling-island](./packages/sapling-island/) | A web component for partial hydration | [CDN](https://sapling-is.land) |

## Examples

We would recommend checking out the [Sapling Examples Repository](https://github.com/withsapling/examples) for more examples of how to use Sapling.

## Attributions

- [Hono](https://github.com/honojs/hono) - Our html and raw HTML helpers are based on Hono's to allow for easy migration between Sapling and Hono. We are also huge fans of their routing approach which is why we've structured Sapling's API in a similar way.

- [UnoCSS](https://github.com/unocss/unocss) - We use UnoCSS for atomic CSS.

- [marked](https://github.com/markedjs/marked) - Our markdown parser.

- [shiki](https://github.com/shikijs/shiki) - The code highlighter for syntax highlighting.

- [wasm-image-optimization](https://github.com/node-libraries/wasm-image-optimization) - The WASM-based image optimization library we use for image processing.