forked from remix-run/remix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2aab87f
commit 0f8e227
Showing
1 changed file
with
52 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,64 @@ | ||
| --- | ||
| title: Remix Docs Home | ||
| order: 1 | ||
| description: Remix! brings the best of modern web development without leaving behind the fundamental parts that make it great. Deploy server rendered, code split, dynamic-data driven React apps to any cloud service provider. Experience unparalleled performance and leave the big build process behind. | ||
| description: Learn how to Build Better Websites with Remix. | ||
| toc: false | ||
| hidden: true | ||
| --- | ||
|
|
||
| # Remix Documentation | ||
| # Remix Docs | ||
|
|
||
| Welcome to Remix! We have put our heart and soul into this project. The API is pretty stable now and now we're tightening the screws on this thing. We don't expect more breaking API changes (but no promises 😅) as we work toward a 1.0 release. These docs are still a bit incomplete and written in a hurry, but they're good enough to get you moving. | ||
| Holy smokes you're here! Let's do this. Welcome to the v1 stable release of Remix! Just so we're all clear, this is newly open sourced, so stable means "the API is stable", it doesn’t mean we don't have any bugs 😅 (though, we think we're doing alright). Let us know if you think you found one on [GitHub](https://github.com/remix-run/remix). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Before anything else, do the [Quickstart Tutorial](tutorial/1-installation/), it'll only take a few minutes and will introduce you to the key concepts, conventions, and APIs in Remix. | ||
| - Skim the docs, these are the two you'll end up referencing the most: | ||
| - [Application Module APIs](/api/app) | ||
| - [Remix Package](/api/remix) | ||
| - Check out the [Remix Philosophy](guides/philosophy) | ||
| ```sh | ||
| npx create-remix@latest | ||
| ``` | ||
|
|
||
| ## Getting help | ||
| We **strongly encourage you** to do one of the tutorials before anything else. Remix is different. The tutorials will show you how to start with web fundamentals and then progressively enhance your app to the modern UX you're after. | ||
|
|
||
| The [Support](https://remix.run/dashboard/support) page lists several resources to get help, check it out if you're stuck (and you will be, things are changing fast at the moment). We are very active on the [discord server](https://remix.run/dashboard/chat) so you'll probably get help fastest there. Please don't be shy! | ||
| <docs-cards> | ||
| <a href="main/tutorials/jokes" aria-label="Jokes App Tutorial"> | ||
| <docs-card> | ||
| <h4>Jokes App Quickstart</h4> | ||
| <p>Spend your first 30 minutes with Remix building a full stack <i>Tell me a joke</i> app, backed by a SQL database with user authentication and modern UI finishes. You'll learn about nested routes, sessions, data loading, data mutations, progressive enhancement, and more. Get a feel for what a data-backed web app feels like with Remix.</p> | ||
| </docs-card> | ||
| </a> | ||
| <a href="main/tutorials/blog" aria-label="Developer Blog Tutorial"> | ||
| <docs-card> | ||
| <h4>Developer Blog Quickstart</h4> | ||
| <p>Yeah, yeah, we know, you want to redo your personal blog with Remix. Remix is a lot more capable than rendering markdown into HTML, so we'll show how to start simple (Remix scales down) and then scale up to a full blogging platform backed by a CMS (it scales up too!).</p> | ||
| </docs-card> | ||
| </a> | ||
| <a href="main/api/conventions" aria-label="Conventional APIs"> | ||
| <docs-card> | ||
| <h4>Conventional APIs</h4> | ||
| <p>Remix has a handful of conventions to make web application development a breeze. You'll spend some time in this document when you're first learning Remix, but probably won't need it much after you get your feet wet.</p> | ||
| </docs-card> | ||
| </a> | ||
| <a href="main/api/remix" aria-label="Remix API"> | ||
| <docs-card> | ||
| <h4>Remix Package API</h4> | ||
| <p>This is probably the doc page you'll visit the most. It's got all of the Remix package exports that you'll use day-to-day in your app.</p> | ||
| </docs-card> | ||
| </a> | ||
| </docs-cards> | ||
|
|
||
| And with that, good luck! We hope you love Remix. | ||
| ## Community | ||
|
|
||
| <docs-cards> | ||
| <a href="https://rmx.as/GitHub" aria-label="GitHub Repository"> | ||
| <docs-card> | ||
| <h4>GitHub Repository</h4> | ||
| <p>Follow along and contribute to the development of Remix. We actually love typo PRs.</p> | ||
| <p>GitHub Discussions is also the best place to get help when you're stuck. Other folks can post answers for the next person to see.</p> | ||
| </docs-card> | ||
| </a> | ||
| <a href="https://rmx.as/discord" aria-label="Remix Discord"> | ||
| <docs-card> | ||
| <h4>Discord Server</h4> | ||
| <p>Join our awesome community of developers for realtime discussion, help, and showing off what you built! Good vibes only.</p> | ||
| </docs-card> | ||
| </a> | ||
| </docs-cards> |