mirror of
https://github.com/tauri-apps/tauri-docs.git
synced 2026-01-31 00:35:16 +01:00
add page stubs and update sidebar links
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
This commit is contained in:
Lorenzo Lewis
@@ -49,7 +49,7 @@ export default defineConfig({
|
||||
},
|
||||
{
|
||||
label: 'Core Concepts',
|
||||
link: '2/guide/upgrade',
|
||||
link: '2/guide/core-concepts',
|
||||
},
|
||||
{
|
||||
label: 'Plugins',
|
||||
@@ -62,33 +62,29 @@ export default defineConfig({
|
||||
items: [
|
||||
{
|
||||
label: 'Develop',
|
||||
link: '#',
|
||||
link: '2/guide/develop',
|
||||
},
|
||||
{
|
||||
label: 'Debug',
|
||||
link: '#',
|
||||
link: '2/guide/debug',
|
||||
},
|
||||
{
|
||||
label: 'Test',
|
||||
link: '#',
|
||||
link: '2/guide/test',
|
||||
},
|
||||
{
|
||||
label: 'Build',
|
||||
link: '#',
|
||||
label: 'Build & Distribute',
|
||||
link: '2/guide/build-distribute',
|
||||
},
|
||||
{
|
||||
label: 'Distribute',
|
||||
link: '#',
|
||||
},
|
||||
{
|
||||
label: 'Troubleshooting',
|
||||
link: '/2/guide/troubleshoot',
|
||||
label: 'Troubleshoot',
|
||||
link: '2/guide/troubleshoot',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Features & Recipes',
|
||||
link: '#',
|
||||
link: '2/recipe',
|
||||
},
|
||||
{
|
||||
label: 'References',
|
||||
|
||||
23
src/components/Stub.astro
Normal file
23
src/components/Stub.astro
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
import { Card } from '@astrojs/starlight/components';
|
||||
|
||||
const baseUrl = 'https://github.com/tauri-apps/tauri-docs/tree/starlight';
|
||||
---
|
||||
|
||||
<Card title="Contribute" icon="pencil">
|
||||
<p>
|
||||
This page is a stub and is waiting for contributions. Get involved by
|
||||
<a href={baseUrl}>visiting us on GitHub</a> or <a
|
||||
href="https://discord.com/invite/tauri">joining us on Discord</a
|
||||
>.
|
||||
</p>
|
||||
|
||||
{
|
||||
Astro.slots.has('default') && (
|
||||
<>
|
||||
<div>Here are some ideas to get you started:</div>
|
||||
<slot />
|
||||
</>
|
||||
)
|
||||
}
|
||||
</Card>
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Android
|
||||
---
|
||||
@@ -2,52 +2,16 @@
|
||||
title: Building & Distribution
|
||||
---
|
||||
|
||||
import { Card, CardGrid } from "@astrojs/starlight/components";
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
Could either include the signing process within each of these guides or have them as separate guides
|
||||
<Stub>
|
||||
|
||||
TODO: Pending https://github.com/withastro/starlight/pull/397 to get merged/released for the below cards
|
||||
- Building & Code Signing for...
|
||||
- Linux
|
||||
- macOS
|
||||
- Windows
|
||||
- Android
|
||||
- iOS
|
||||
- Updater (link to recipe)
|
||||
|
||||
## Building
|
||||
|
||||
<CardGrid>
|
||||
<Card title="Linux" icon="star">
|
||||
|
||||
[link](/2/guide/build-distribute/linux)
|
||||
|
||||
</Card>
|
||||
<Card title="macOS" icon="moon">
|
||||
|
||||
[link](/2/guide/build-distribute/macos)
|
||||
|
||||
</Card>
|
||||
<Card title="Windows" icon="star">
|
||||
|
||||
[link](/2/guide/build-distribute/windows)
|
||||
|
||||
</Card>
|
||||
<Card title="Android" icon="star">
|
||||
|
||||
[link](/2/guide/build-distribute/android)
|
||||
|
||||
</Card>
|
||||
<Card title="iOS" icon="star">
|
||||
|
||||
[link](/2/guide/build-distribute/ios)
|
||||
|
||||
</Card>
|
||||
</CardGrid>
|
||||
|
||||
## Signing
|
||||
|
||||
<CardGrid>
|
||||
<Card title="Linux" icon="star"></Card>
|
||||
<Card title="macOS" icon="moon"></Card>
|
||||
<Card title="Windows" icon="star"></Card>
|
||||
<Card title="Android" icon="star"></Card>
|
||||
<Card title="iOS" icon="star"></Card>
|
||||
</CardGrid>
|
||||
|
||||
## Updates
|
||||
|
||||
TODO: Link out to plugin guide
|
||||
</Stub>
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: iOS
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Linux
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: macOS
|
||||
---
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Windows
|
||||
---
|
||||
11
src/content/docs/2/guide/core-concepts.mdx
Normal file
11
src/content/docs/2/guide/core-concepts.mdx
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Core Concepts
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub>
|
||||
|
||||
SPAs, SSG, etc.
|
||||
|
||||
</Stub>
|
||||
@@ -3,6 +3,16 @@ title: Create a Project
|
||||
---
|
||||
|
||||
import { Tabs, TabItem, Card } from '@astrojs/starlight/components';
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub>
|
||||
|
||||
- Create a new app using `create-tauri-app`
|
||||
- Manually create the app using the Tauri CLI
|
||||
- Add mobile to an existing project
|
||||
- Frontend framework-specific guides (right now limiting to React, Angular, Vue, Svelte, and Solid)
|
||||
|
||||
</Stub>
|
||||
|
||||
One thing that makes Tauri so flexible is it's ability to work with virtually any frontend framework. We've created the [`create-tauri-app`](https://github.com/tauri-apps/create-tauri-app) utility to help you create a new Tauri project using one of the officially maintained framework templates.
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
title: Customization
|
||||
---
|
||||
|
||||
import { Card, CardGrid } from "@astrojs/starlight/components";
|
||||
|
||||
Tauri offers many ways to customize your app and make it a unique experience.
|
||||
|
||||
(Each one of the below would be a link to a guide specific to it)
|
||||
|
||||
{/* TODO: Open issue about making links clickable */}
|
||||
|
||||
<CardGrid>
|
||||
<Card title="Icons" icon="star">
|
||||
Text to explain feature
|
||||
</Card>
|
||||
<Card title="Window" icon="star">
|
||||
Text to explain feature
|
||||
</Card>
|
||||
</CardGrid>
|
||||
7
src/content/docs/2/guide/debug.mdx
Normal file
7
src/content/docs/2/guide/debug.mdx
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Debug
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub />
|
||||
7
src/content/docs/2/guide/develop.mdx
Normal file
7
src/content/docs/2/guide/develop.mdx
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Develop
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub />
|
||||
@@ -2,14 +2,18 @@
|
||||
title: Why Tauri?
|
||||
---
|
||||
|
||||
import { Card } from "@astrojs/starlight/components";
|
||||
import { Card } from '@astrojs/starlight/components';
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub />
|
||||
|
||||
:::caution[Prerelease Software]
|
||||
This documentation is for the prereleased version of Tauri 2.0 and is subject to change as development continues. If you're looking for Tauri 1.0 documentation visit https://tauri.app.
|
||||
:::
|
||||
|
||||
<Card title="Next Steps" icon="rocket">
|
||||
Get ready to make a Tauri project by installing the [prerequisites](/2/guide/prerequisites).
|
||||
Get ready to make a Tauri project by installing the
|
||||
[prerequisites](/2/guide/prerequisites).
|
||||
</Card>
|
||||
|
||||
<Card title="Additional Resources" icon="document">
|
||||
@@ -17,6 +21,5 @@ This documentation is for the prereleased version of Tauri 2.0 and is subject to
|
||||
- 🎥 [Tauri in 100 Seconds](https://www.youtube.com/watch?v=-X8evddpu7M), Fireship (YouTube)
|
||||
{/* - 🎧 [Podcast] */}
|
||||
{/* - 📝 [Post] */}
|
||||
|
||||
</Card>
|
||||
|
||||
</Card>
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
title: Guides List
|
||||
---
|
||||
|
||||
## Official Guides
|
||||
|
||||
- Prerequisites
|
||||
- Create a Project
|
||||
- Troubleshoot
|
||||
- Build and Distribute
|
||||
- Bundle for different OSs
|
||||
- Signing
|
||||
- Customize
|
||||
- Icons
|
||||
- Window
|
||||
- Plugins
|
||||
- Plugin overview
|
||||
- Developing plugins
|
||||
- Guide for each plugin
|
||||
- Misc.
|
||||
- IPC
|
||||
- Embedding external files: https://tauri.app/v1/guides/building/resources
|
||||
- Embedding external binaries: https://tauri.app/v1/guides/building/sidecar
|
||||
|
||||
## Community Guides
|
||||
@@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Authenticator
|
||||
---
|
||||
13
src/content/docs/2/guide/plugins.mdx
Normal file
13
src/content/docs/2/guide/plugins.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Plugins
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub>
|
||||
|
||||
- What is a Plugin?
|
||||
- Developing a Plugin
|
||||
- Guide/Recipe for each plugin in https://github.com/tauri-apps/plugins-workspace/tree/v2
|
||||
|
||||
</Stub>
|
||||
7
src/content/docs/2/guide/test.mdx
Normal file
7
src/content/docs/2/guide/test.mdx
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Test
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub />
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
---
|
||||
|
||||
TODO: Troubleshooting guide
|
||||
7
src/content/docs/2/guide/troubleshoot.mdx
Normal file
7
src/content/docs/2/guide/troubleshoot.mdx
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub />
|
||||
13
src/content/docs/2/guide/upgrade-migrate/index.mdx
Normal file
13
src/content/docs/2/guide/upgrade-migrate/index.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Upgrade & Migrate
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub>
|
||||
|
||||
- From Tauri 1.0
|
||||
- Electron to Tauri
|
||||
- Flutter to Tauri
|
||||
|
||||
</Stub>
|
||||
13
src/content/docs/2/recipe/index.mdx
Normal file
13
src/content/docs/2/recipe/index.mdx
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Features & Recipes
|
||||
---
|
||||
|
||||
import Stub from '@components/Stub.astro';
|
||||
|
||||
<Stub>
|
||||
|
||||
- Features included in Tauri Core
|
||||
- A guide/recipe for each plugin
|
||||
- Any other recipes that would be amazing to add in
|
||||
|
||||
</Stub>
|
||||
Reference in New Issue
Block a user