Skip to content

Commit

Permalink
added link to github
Browse files Browse the repository at this point in the history
  • Loading branch information
steven-tey committed Jun 16, 2023
1 parent 8582f66 commit 67b274d
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

## Introduction

[Novel](https://novel.sh/) is a Notion-style WYSYWIG editor with AI-powered autocompletions.
[Novel](https://novel.sh/) is a Notion-style WYSYWIG editor with AI-powered autocompletions.

https://github.com/steven-tey/novel/assets/28986134/97ac8a8c-4b73-4b23-9010-6474156fbb51

Expand All @@ -37,21 +37,21 @@ You can deploy your own version of Novel to Vercel with one click:

[![Deploy with Vercel](https://vercel.com/button)](https://stey.me/novel-deploy)


## Tech Stack

Novel is built on the following stack:

- [Next.js](https://nextjs.org/) – framework
- [Tiptap](https://tiptap.dev/) – text editor
- [OpenAI](https://openai.com/) - AI completions
- [Vercel AI SDK](https://sdk.vercel.ai/docs)- AI library
- [Vercel AI SDK](https://sdk.vercel.ai/docs) AI library
- [Vercel](https://vercel.com) – deployments
- [TailwindCSS](https://tailwindcss.com/) – styles
- [Cal Sans](https://github.com/calcom/font) – font

## Contributing

Here's how you can contribute:
Here's how you can contribute:

- [Open an issue](https://github.com/steven-tey/novel/issues) if you believe you've encountered a bug.
- Make a [pull request](https://github.com/steven-tey/novel/pull) to add new features/make quality-of-life improvements/fix bugs.
Expand Down
17 changes: 13 additions & 4 deletions app/page.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
import type { Metadata } from "next";
import Editor from "@/ui/editor";
import Github from "@/ui/shared/github";

export default function Page() {
return (
<div className="flex min-h-screen flex-col items-center sm:px-5 sm:pt-[calc(20vh)]">
<Editor />
</div>
<>
<a
href="/github"
target="_blank"
className="absolute bottom-5 right-5 max-h-fit rounded-lg p-2 transition-colors duration-200 hover:bg-stone-100 sm:top-5"
>
<Github />
</a>
<div className="flex min-h-screen flex-col items-center sm:px-5 sm:pt-[calc(20vh)]">
<Editor />
</div>
</>
);
}
2 changes: 1 addition & 1 deletion ui/editor/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export default function Editor() {
}, [isLoading, editor, completion]);

return (
<div className="relative min-h-[500px] w-full max-w-screen-lg border-stone-200 p-12 px-8 sm:rounded-lg sm:border sm:px-12 sm:shadow-lg">
<div className="relative min-h-[500px] w-full max-w-screen-lg border-stone-200 p-12 px-8 sm:mb-[calc(20vh)] sm:rounded-lg sm:border sm:px-12 sm:shadow-lg">
<div className="absolute right-5 top-5 mb-5 rounded-lg bg-stone-100 px-2 py-1 text-sm text-stone-400">
{saveStatus}
</div>
Expand Down
14 changes: 14 additions & 0 deletions ui/shared/github.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
export default function Github({ className }: { className?: string }) {
return (
<svg
xmlns="http://www.w3.org/2000/svg"
width="20"
height="20"
fill="currentColor"
viewBox="0 0 24 24"
className={className}
>
<path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z" />
</svg>
);
}

0 comments on commit 67b274d

Please sign in to comment.