diff --git a/README.md b/README.md index 01df6d0..3f0c63c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,26 @@ + + Prose UI social image + + # 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 diff --git a/apps/website/content/docs/roadmap.mdx b/apps/website/content/docs/roadmap.mdx index 58e528f..3e921ec 100644 --- a/apps/website/content/docs/roadmap.mdx +++ b/apps/website/content/docs/roadmap.mdx @@ -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! \ No newline at end of file diff --git a/apps/website/src/app/editor/page.tsx b/apps/website/src/app/editor/page.tsx index 70d305c..9e2a96f 100644 --- a/apps/website/src/app/editor/page.tsx +++ b/apps/website/src/app/editor/page.tsx @@ -23,10 +23,12 @@ const Templates = () => { Prose UI MDX is fully supported by Dhub - a collaborative WYSIWYG editor for MDX content with direct GitHub publishing.

- Screenshot of Dhub's WYSIWYG editor with MarkDown preview open on the right side + + Screenshot of Dhub's WYSIWYG editor with Markdown preview open on the right side +