Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

Commit 2600fd9

Browse files
authored
Update README.md
1 parent 659337e commit 2600fd9

File tree

1 file changed

+6
-58
lines changed

1 file changed

+6
-58
lines changed

README.md

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,20 @@
22

33
# Aleph.js
44

5-
Aleph.js (or **Aleph** or **א**, /ˈɑːlɛf/) is a React Framework in [Deno](https://deno.land), inspired by [Next.js](https://nextjs.org).
6-
<br>
5+
Aleph.js (or **Aleph** or **א**, /ˈɑːlɛf/) is a full-stack framework in [Deno](https://deno.land).
6+
77
[Website](https://alephjs.org) | [Get Started](https://alephjs.org/docs/get-started) | [Docs](https://alephjs.org/docs) | [ESM](https://esm.sh) | [The Aleph (by Jorge Luis Borges)](http://www.phinnweb.org/links/literature/borges/aleph.html)
88

99
[![Aleph.js in Deno](https://github.com/alephjs/aleph.js/workflows/Aleph.js%20in%20Deno/badge.svg)](https://github.com/alephjs/aleph.js/actions?query=workflow%3A%22Aleph.js+in+Deno%22)
1010
[![nest badge](https://nest.land/badge.svg)](https://nest.land/package/aleph)
1111
[![Chat](https://img.shields.io/discord/775256646821085215?color=%23008181&label=Chat&labelColor=%23111&logo=discord&logoColor=%23aaaaaa)](https://discord.gg/pWGdS7sAqD)
1212
[![Twitter Follow](https://img.shields.io/twitter/follow/alephjs?style=social)](https://twitter.com/intent/follow?screen_name=alephjs)
1313

14-
Different with Next.js, Aleph.js don't need **webpack** or other bundler since it uses the **ESM** imports syntax. Every module only needs to be compiled once and then cached on the disk. When a module changes, Aleph.js just needs to re-compile that single module, there's no time wasted to *re-bundle* every changes, and instantly updates in the browser by **HMR** (Hot Module Replacement) with **React Fast Refresh**.
15-
16-
Aleph.js works in **Deno**, a *simple*, *modern* and *secure* runtime for JavaScript and TypeScript. No `package.json` and `node_modules` directory needed, all dependencies are imported as URL and managed by Aleph.js:
17-
18-
```jsx
19-
import React from "https://esm.sh/[email protected]"
20-
import Logo from "../components/logo.tsx"
21-
22-
export default function App() {
23-
return (
24-
<div>
25-
<Logo />
26-
<h1>Hello World!</h1>
27-
</div>
28-
)
29-
}
30-
```
31-
32-
### Features
33-
34-
- Zero Config
35-
- Typescript in Deno
36-
- High Performance Comilper
37-
- ES Module Ready
38-
- Import Maps
39-
- HMR with Fast Refresh
40-
- File-system Routing
41-
- APIs Routing
42-
- Built-in Markdown Page
43-
- Built-in CSS(Less) Support
44-
- SSR/SSG
45-
46-
### Installation
47-
48-
```bash
49-
deno install -A -f -n aleph https://deno.land/x/[email protected]/cli.ts
50-
```
51-
52-
### Usage
53-
54-
```bash
55-
# create a new app
56-
aleph init hello
57-
cd hello
58-
59-
# start the app in `development` mode
60-
aleph dev
61-
62-
# start the app in `production` mode
63-
aleph start
64-
65-
# build the app to a static site (SSG)
66-
aleph build
14+
### Supported Frameworks
6715

68-
# more usages
69-
aleph -h
70-
```
16+
- React/Preact
17+
- Alef Component (WIP)
18+
- Vuejs (Coming)
7119

7220
### Documentation
7321

0 commit comments

Comments
 (0)