-
Notifications
You must be signed in to change notification settings - Fork 102
Prep for Fumadocs migration #212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
4f2096b
Migrate docs content for Fumadocs
yagil f2c20da
Organize Fumadocs section metadata
yagil 86cb996
Convert docs callout pages to MDX
yagil 6fc6a66
Clean up docs content for Fumadocs
yagil 821cd2d
Convert quickstart docs to Fumadocs steps
yagil 47ec7b3
Use Fumadocs cards and steps in docs
yagil 348630f
Add docs home navigation cards
yagil 2293e17
Remove self-link from app docs landing
yagil File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "title": "Introduction", | ||
| "pages": [ | ||
| "offline", | ||
| "system-requirements" | ||
| ] | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: Get started with LM Studio | ||
| sidebar_title: Overview | ||
| description: Download and run Large Language Models like Qwen, Mistral, Gemma, or gpt-oss in LM Studio. | ||
| index: 1 | ||
| --- | ||
|
|
||
| import { Step, Steps } from "fumadocs-ui/components/steps"; | ||
|
|
||
| Double check computer meets the minimum [system requirements](/docs/system-requirements). | ||
|
|
||
| <Callout type="info" title="Info"> | ||
| You might sometimes see terms such as `open-source models` or `open-weights models`. Different models might be released under different licenses and varying degrees of 'openness'. In order to run a model locally, you need to be able to get access to its "weights", often distributed as one or more files that end with `.gguf`, `.safetensors` etc. | ||
| </Callout> | ||
|
|
||
| <hr /> | ||
|
|
||
| ## Getting up and running | ||
|
|
||
| First, **install the latest version of LM Studio**. You can get it from [here](/download). | ||
|
|
||
| Once you're all set up, you need to **download your first LLM**. | ||
|
|
||
| <Steps> | ||
| <Step> | ||
| <h3>Download an LLM to your computer</h3> | ||
|
|
||
| Head over to the Discover tab to download models. Pick one of the curated options or search for models by search query (e.g. `"Llama"`). See more in-depth information about downloading models [here](/docs/basics/download-models). | ||
|
|
||
| <img src="/assets/marketing/docs/discover.png" style={{ width: "500px", marginTop: "30px" }} data-caption="The Discover tab in LM Studio" /> | ||
| </Step> | ||
|
|
||
| <Step> | ||
| <h3>Load a model to memory</h3> | ||
|
|
||
| Head over to the **Chat** tab, and | ||
|
|
||
| 1. Open the model loader | ||
| 2. Select one of the models you downloaded (or [sideloaded](/docs/advanced/sideload)). | ||
| 3. Optionally, choose load configuration parameters. | ||
|
|
||
| <img src="/assets/marketing/docs/loader.png" data-caption="Quickly open the model loader with `cmd` + `L` on macOS or `ctrl` + `L` on Windows/Linux" /> | ||
|
|
||
| <h4>What does loading a model mean?</h4> | ||
|
|
||
| Loading a model typically means allocating memory to be able to accommodate the model's weights and other parameters in your computer's RAM. | ||
| </Step> | ||
|
|
||
| <Step> | ||
| <h3>Chat!</h3> | ||
|
|
||
| Once the model is loaded, you can start a back-and-forth conversation with the model in the Chat tab. | ||
|
|
||
| <img src="/assets/marketing/docs/chat.png" data-caption="LM Studio on macOS" /> | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| <hr /> | ||
|
|
||
| ### Community | ||
|
|
||
| Chat with other LM Studio users, discuss LLMs, hardware, and more on the [LM Studio Discord server](https://discord.gg/aPQfnNkxGC). |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "title": "Getting Started", | ||
| "pages": [ | ||
| "chat", | ||
| "_connect-apps", | ||
| "download-model", | ||
| "_keychords", | ||
| "lmstudio-vs-llmster-vs-lms", | ||
| "rag", | ||
| "_troubleshooting" | ||
| ] | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "MCP", | ||
| "pages": [ | ||
| "deeplink" | ||
| ] | ||
| } |
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "title": "model.yaml", | ||
| "pages": [ | ||
| "publish" | ||
| ] | ||
| } |
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "title": "Presets", | ||
| "pages": [ | ||
| "import", | ||
| "publish", | ||
| "pull", | ||
| "push" | ||
| ] | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.