tiny-essay-editor - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #rust #deep-learning #linux #macos #awesome #cli #awesome-list #security #mcp

tiny-essay-editor

(★ 260)

simple markdown editor w inline comments, on latest automerge stack

파일 탐색기

최종 버전 다운로드 (.zip)

- - black-square.png
  - highlight.css
  - logo-favicon-128x128.png
  - logo-favicon-16x16.png
  - logo-favicon-192x192.png
  - logo-favicon-196x196.png
  - logo-favicon-310x310-transparent.png
  - logo-favicon-32x32.png
  - logo-favicon-64x64.png
  - logo-favicon-96x96.png
  - logo-favicon-apple-touch.png
  - logo-lockup.svg
  - prism.js
  - splat-article-last.svg
  - splat-separator-1.svg
  - splat-span.svg
  - splat-underline-1-default.svg
  - splat-underline-1-hover.svg
  - splat-underline-2-default.svg
  - splat-underline-2-hover.svg
  - splat.svg
- apple-touch-icon.png
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- vite.svg
- - account.ts
  - index.css
  - main.tsx
  - mount.ts
  - navigation.ts
  - tools.ts
  - utils.ts
- - datatype.ts
  - useDocumentWithLinks.ts
  - useFolderDocWithChildren.ts
- - utils.ts
- - assets.ts
  - datatype.ts
  - index.css
  - main.tsx
  - mount.ts
  - schema.ts
  - utils.ts
- - datatype.ts
  - main.tsx
  - mount.ts
  - schema.ts
- datatypes.ts
- index.ts
- vite-env.d.ts
- SyncIndicator.test.ts
- useFolderDocWithChildren.test.tsx
.eslintrc.cjs
.gitignore
components.json
index.html
package.json
postcss.config.js
README.md
service-worker.js
standalone.html
tailwind.config.js
tsconfig.json
tsconfig.node.json
tsconfig.trailrunner.json
vite.config.ts
vitest.config.ts
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/inkandswitch/tiny-essay-editor

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tiny-essay-editor

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

yarn

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn dev

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tiny essay editor

This is a simple collaborative Markdown editor built in React, with inline format preview and inline commenting.

It's built on [automerge](https://github.com/automerge/automerge) and [automerge-repo](https://github.com/automerge/automerge-repo) for CRDT-based storage and sync. It uses [Codemirror](https://codemirror.net/) for markdown editing UI, and [automerge-codemirror](https://github.com/automerge/automerge-codemirror) to connect to Codemirror.

<img width="1318" alt="CleanShot 2023-11-08 at 14 15 49@2x" src="https://github.com/inkandswitch/tiny-essay-editor/assets/934016/672e0642-0ecd-47f6-8595-be2629a4e265">

## Usage

If you visit the root domain the app will make a new doc. Or you can hit the New button.

Once you have a doc, the URL will update with a doc ID. If you share that URL to another browser/device, it should sync live. Hold on to the URL if you want to come back to that doc!

### Features

- Edit Markdown with inline format preview
- Write inline comments + replies
- Live sync through Automerge
- Stores data to local device
- Save out .md file with a Download button
- Typeset similarly to Ink & Switch essays

### Status

This app is primarily intended for internal use at Ink & Switch for editing essays, so there are some features that are specialized towards that use case. We don't plan to develop it into a general-purpose editor that anyone can use for anything. But of course, it can edit any Markdown document too. If you want to actually use this editor in earnest, you might want to fork it to build your own ideas.

Hopefully the code serves as a useful sample for building apps based on automerge-repo, automerge-codemirror, and React.

## Development

### Run it

```
yarn
yarn dev
```

### Dual deployment

This app is designed for normal webapp deployment as well as experimental deployment to an internal I&S platform. The code is almost entirely shared but there are two entry points:

- `src/main.tsx` is the normal app entry point
- `src/index.ts` is an experimental entry point which just exports some functions to a host environment

### Adding a new datatype

This app is actually a general framework for editing automerge docs in viewers, which currently has specific support for markdown documents and tldraw whiteboards.

Basic instructions to add a new datatype:

- copy an existing `src/{datatype}` directory as a template. `tee` is a reasonable example
- Fill in `src/<your_datatype>/datatype.ts` with a TS type, an init function, and other functions
- Add your new datatype to the `datatypes` map in `src/datatypes.ts`
-