Code Monkey home page Code Monkey logo

alphonse's Introduction

Alphonse Editor

An open-source Notion-style WYSIWYG editor build with shadcn/ui and tailwind.

Check the project

Alphonse Editor online demo

Instalation

npm install alphonse

Usage

"use client";

import React from "react";
import {
  AlphonseProvider,
  AlphonseEditorProvider,
  AlphonseEditor,
} from "alphonse";

const content = `
<h1>Hello World! 🌎️</h1>
<p>The best notion like editor</p>
`;

export const Editor = () => {
  return (
    <>
      <AlphonseProvider>
        <AlphonseEditorProvider content={content}>
          <AlphonseEditor />
        </AlphonseEditorProvider>
      </AlphonseProvider>
    </>
  );
};

Tech Stack

Alphonse is built on the following stack:

What's inside?

This repo includes the following packages/apps:

Apps and Packages

  • web: a Next.js app as an example of usage
  • alphonse: The editor itselft will be delivery as a npm package in the future
  • @alphonse/ui: shadcn/ui components and custom components for alphonse editor

Each package/app is 100% TypeScript.

Build

To build all apps and packages, run the following command:

cd alphonse
pnpm install
pnpm build

Develop

To develop all apps and packages, run the following command:

cd alphonse
pnpm install
pnpm dev

alphonse's People

Contributors

brunocroh avatar turbobot-temp avatar

Stargazers

Matheus Cascão avatar Bruno Wego avatar PLin2023 avatar

Watchers

 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.