mirror of
https://github.com/tuono-labs/tuono
synced 2026-07-25 12:52:47 -07:00
docs(configuration): fill page content (#307)
Co-authored-by: Marco Pasqualetti <marco.pasqualetti@live.com>
This commit is contained in:
@@ -2,5 +2,5 @@ import type { JSX } from 'react'
|
||||
import { Text, type TextProps } from '@mantine/core'
|
||||
|
||||
export default function MdxBold(props: TextProps): JSX.Element {
|
||||
return <Text fw={700} {...props} />
|
||||
return <Text component="span" fw={700} {...props} />
|
||||
}
|
||||
|
||||
@@ -239,7 +239,7 @@ export const sidebarElements: Array<SidebarElement> = [
|
||||
},
|
||||
{
|
||||
type: 'element',
|
||||
label: 'tuono.config.ts',
|
||||
label: 'Configuration',
|
||||
href: '/documentation/configuration',
|
||||
},
|
||||
|
||||
|
||||
@@ -11,4 +11,39 @@ import Breadcrumbs, { Element } from '@/components/breadcrumbs'
|
||||
|
||||
# Configuration
|
||||
|
||||
TODO
|
||||
Tuono can be configured using the `tuono.config.ts` file,
|
||||
which allows you to customize various aspects of the build process and development environment.
|
||||
|
||||
The config file is written in TypeScript,
|
||||
so you can take advantage of type checking and auto-suggestions provided by the `TuonoConfig` type,
|
||||
which is exported from `tuono/config`.
|
||||
|
||||
```ts
|
||||
import type { TuonoConfig } from 'tuono/config'
|
||||
|
||||
const config: TuonoConfig = {
|
||||
/* typesafe config */
|
||||
}
|
||||
|
||||
export default config
|
||||
```
|
||||
|
||||
## vite
|
||||
|
||||
Tuono leverages Vite, a modern and fast build tool and development server for web applications.
|
||||
|
||||
As a result, **some** Vite configuration properties can be set in the `tuono.config.ts` file under the `vite` property.
|
||||
|
||||
### vite.alias
|
||||
|
||||
Useful for configuring custom source alias paths during imports. [ 👉 Read more here](https://vite.dev/config/shared-options)
|
||||
|
||||
> 💡 You can find a working example in the `tuono-tutorial` template or in the documentation itself!
|
||||
|
||||
### vite.optimizeDeps
|
||||
|
||||
Vite's dependency optimizer used only during dev. [ 👉 Read more here](https://vite.dev/config/dep-optimization-options)
|
||||
|
||||
### vite.plugins
|
||||
|
||||
Useful for extending vite's functionality. [ 👉 Read more here](https://vite.dev/guide/using-plugins)
|
||||
|
||||
@@ -74,10 +74,11 @@ cargo build
|
||||
#### Introduction
|
||||
|
||||
Docker takes care of configuring the development environment, so you don’t need to worry about installing specific versions of packages like Node.js or pnpm. The Docker image handles this for you!
|
||||
Using Docker, **the only operations you’ll need to manage on your host machine are related to git**. (don't use phpnm, cargo, ... from your host machine)
|
||||
Using Docker, **the only operations you’ll need to manage on your host machine are related to git**. (don't use pnpm, cargo, ... from your host machine)
|
||||
Some IDEs (such as vscode with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)) allow you to connect directly to the Docker container.
|
||||
|
||||
**Before proceeding with this guide, make sure that the `node_modules` and `target` directories are either absent or empty in the subprojects of Tuono from your host machine where you want to contribute.** This ensures a clean and consistent environment when using Docker.
|
||||
**Before proceeding with this guide, make sure that the `node_modules` and `target` directories are either absent or empty in the subprojects of Tuono from your host machine where you want to contribute.**
|
||||
This ensures a clean and consistent environment when using Docker.
|
||||
|
||||
#### Build the Tuono's Docker Container
|
||||
|
||||
|
||||
Reference in New Issue
Block a user