Skip to content

Commit

Permalink
improve content and README
Browse files Browse the repository at this point in the history
  • Loading branch information
vrepsys committed Jan 7, 2025
1 parent 0940874 commit 8597716
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 20 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
<a href="https://prose-ui.com" >
<img alt="Prose UI social image" src="https://repository-images.githubusercontent.com/898552859/60af321f-9566-42e9-9a20-6120a366639a">
</a>

# Prose UI

**Refined typography and components for building content-focused websites with Next.js and MDX.**
Prose UI provides polished typography and components for content-focused websites that use MDX.

## Documentation

For full documentation, visit [prose-ui.com](https://prose-ui.com).

## Getting Started

This is a monorepo that contains the website, docs, and source code of Prose UI npm packages.

To run the website locally:

```bash
cd apps/website
pnpm dev
```

Prose UI is an open-source library for Next.js that provides styles, components, and Remark plugins to render professional-looking content for documentation, blogs, and other content-focused websites.
---

Visit [prose-ui.com](https://prose-ui.com) for installation instructions, usage guidelines, and detailed documentation.
Copyright © 2024-present Valdemaras Repšys
21 changes: 8 additions & 13 deletions apps/website/content/docs/roadmap.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
# Roadmap

Prose UI started with a simple goal: to provide a consistent MDX experience with standardized components.
We wanted to make it easier for anyone building content-focused websites—whether it's a blog, documentation site, knowledge base, or even a full documentation framework—to drop Prose UI into their project without reinventing the wheel.
While we have many ideas for Prose UI, we try to prioritize quality over quantity, so a lot of functionality we'd love to have is still not there.
Here's what's planned for the future:

While there's a lot we dream of adding to Prose UI, our focus is on quality over quantity.
We want every feature to work seamlessly and every design element to feel just right. A huge thanks goes to [Domas](https://domasmark.us) for his invaluable design contributions—Prose UI wouldn't be what it is without his help.

Here’s what’s coming next:

- Image zoom
- Support for LaTeX formulas
- Tabs component, including for code blocks
- Image zoom (click to expand, gallery view)
- LaTeX support for mathematical notation
- Tabbed interfaces, including code block tabs for multiple languages
- Line highlighting in code blocks
- API reference components to document your APIs

Have ideas, feature requests, or just want to chat? [Get in touch](https://x.com/vrepsys)—we’d love to hear from you!
- API reference components
- Support for other frameworks (Astro) and generic React projects (not just Next.js)

Got ideas or just want to chat about Prose UI? [Drop me a line](https://x.com/vrepsys)—I'd love to hear your thoughts!
10 changes: 6 additions & 4 deletions apps/website/src/app/editor/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ const Templates = () => {
Prose UI MDX is fully supported by <Link href="https://dhub.dev">Dhub</Link> - a
collaborative WYSIWYG editor for MDX content with direct GitHub publishing.
</p>
<Image
src={dhubDemo}
alt="Screenshot of Dhub's WYSIWYG editor with MarkDown preview open on the right side"
/>
<a href="https://dhub.dev" target="_blank">
<Image
src={dhubDemo}
alt="Screenshot of Dhub's WYSIWYG editor with Markdown preview open on the right side"
/>
</a>
</div>
</div>
<Footer />
Expand Down
3 changes: 3 additions & 0 deletions packages/styles/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Styles

Design system and styles for [Prose UI](https://prose-ui.com).

0 comments on commit 8597716

Please sign in to comment.