Skip to content

Commit 2c965f1

Browse files
committed
chore: Update docs
1 parent 6c68d90 commit 2c965f1

File tree

20 files changed

+395
-209
lines changed

20 files changed

+395
-209
lines changed

docs/app/app.config.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export default defineAppConfig({
22
ui: {
33
colors: {
4-
primary: 'green',
4+
primary: 'reactmos-blue',
55
neutral: 'slate'
66
}
77
},
@@ -17,12 +17,12 @@ export default defineAppConfig({
1717
siteName: 'Reactmos - Build React SPAs with modules'
1818
},
1919
header: {
20-
title: '',
20+
title: 'Reactmos',
2121
to: '/',
2222
logo: {
2323
alt: '',
24-
light: '',
25-
dark: ''
24+
light: '/light.png',
25+
dark: '/dark.png'
2626
},
2727
search: true,
2828
colorMode: true,
@@ -47,7 +47,7 @@ export default defineAppConfig({
4747
title: 'Table of Contents',
4848
bottom: {
4949
title: 'Community',
50-
edit: 'https://github.com/nuxt-ui-pro/docs/edit/v3/content',
50+
edit: 'https://github.com/igorjacauna/reactmos/docs/content',
5151
links: [{
5252
icon: 'i-lucide-star',
5353
label: 'Star on GitHub',
@@ -56,4 +56,4 @@ export default defineAppConfig({
5656
}]
5757
}
5858
}
59-
})
59+
})

docs/app/assets/css/main.css

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
@theme static {
77
--font-sans: 'Public Sans', sans-serif;
88

9-
--color-green-50: #EFFDF5;
10-
--color-green-100: #D9FBE8;
11-
--color-green-200: #B3F5D1;
12-
--color-green-300: #75EDAE;
13-
--color-green-400: #00DC82;
14-
--color-green-500: #00C16A;
15-
--color-green-600: #00A155;
16-
--color-green-700: #007F45;
17-
--color-green-800: #016538;
18-
--color-green-900: #0A5331;
19-
--color-green-950: #052E16;
9+
--color-reactmos-blue-50: #eefbfd;
10+
--color-reactmos-blue-100: #d4f3f9;
11+
--color-reactmos-blue-200: #aee6f3;
12+
--color-reactmos-blue-300: #77d2e9;
13+
--color-reactmos-blue-400: #38b5d8;
14+
--color-reactmos-blue-500: #1c97bd;
15+
--color-reactmos-blue-600: #1a7aa0;
16+
--color-reactmos-blue-700: #1c6382;
17+
--color-reactmos-blue-800: #1f526b;
18+
--color-reactmos-blue-900: #1e445b;
19+
--color-reactmos-blue-950: #0e2c3e;
2020
}

docs/content/1.getting-started/1.index.md

Lines changed: 20 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -9,82 +9,55 @@ seo:
99

1010
Reactmos comes from **REACT MOduleS**. The idea is to create SPA applications with React using separate modules. You can progressively expand your application.
1111

12-
This is a work in progress, and many things may change.
12+
::warning
13+
Reactmos is under heavy development. Use with caution. Many things may change
14+
::
1315

1416
For now, these are the implemented features:
1517

1618
::card-group
17-
:::card
18-
---
19-
icon: i-simple-icons-nuxtdotjs
20-
target: _blank
21-
title: Routes
22-
to: https://nuxt.com
23-
---
24-
The Nuxt website
25-
:::
2619

2720
:::card
2821
---
29-
icon: i-simple-icons-nuxtdotjs
3022
target: _blank
31-
title: Nuxt UI
32-
to: https://ui3.nuxt.dev
23+
title: Modules
24+
to: /features/modules
3325
---
34-
The documentation of `@nuxt/ui` and `@nuxt/ui-pro`
26+
How create and extends modules
3527
:::
3628

3729
:::card
3830
---
39-
icon: i-simple-icons-nuxtdotjs
4031
target: _blank
41-
title: Nuxt Image
42-
to: https://image.nuxt.com
43-
---
44-
The documentation of `@nuxt/image`
45-
:::
46-
47-
:::card
48-
---
49-
icon: i-simple-icons-nuxtdotjs
50-
target: _blank
51-
title: Nuxt Content
52-
to: https://content.nuxt.com
32+
title: Routes
33+
to: /features/routes
5334
---
54-
The documentation of `@nuxt/content`
35+
How configure routes
5536
:::
5637

5738
:::card
5839
---
59-
icon: i-simple-icons-nuxtdotjs
6040
target: _blank
61-
title: Nuxt Devtools
62-
to: https://devtools.nuxt.com
41+
title: Hooks
42+
to: /features/hooks
6343
---
64-
The documentation of `@nuxt/devtools`
44+
Use lifecycle hooks and custom hooks
6545
:::
6646

6747
:::card
6848
---
69-
icon: i-simple-icons-nuxtdotjs
7049
target: _blank
71-
title: Nuxt Hub
72-
to: https://hub.nuxt.com
50+
title: Extra configs
51+
to: /features/extra-configs
7352
---
74-
The best place to manage your projects, environments and variables.
53+
Share extra configs between modules
7554
:::
7655
::
7756

78-
## Key Features
57+
## Roadmap
7958

80-
This template includes a range of features designed to streamline documentation management:
59+
We have planned the following for the future:
8160

82-
- **Powered by** [**Nuxt 3**](https://nuxt.com): Utilizes the latest Nuxt framework for optimal performance.
83-
- **Built with** [**Nuxt UI**](https://ui3.nuxt.dev) **and** [**Nuxt UI Pro**](https://ui3.nuxt.dev/pro): Integrates a comprehensive suite of UI components.
84-
- [**MDC Syntax**](https://content.nuxt.com/usage/markdown) **via** [**Nuxt Content**](https://content.nuxt.com): Supports Markdown with component integration for dynamic content.
85-
- [**Nuxt Studio**](https://content.nuxt.com/docs/studio) **Compatible**: Offers integration with Nuxt Studio for content editing.
86-
- **Auto-generated Sidebar Navigation**: Automatically generates navigation from content structure.
87-
- **Full-Text Search**: Includes built-in search functionality for content discovery.
88-
- **Optimized Typography**: Features refined typography for enhanced readability.
89-
- **Dark Mode**: Offers dark mode support for user preference.
90-
- **Extensive Functionality**: Explore the template to fully appreciate its capabilities.
61+
- **publicDir**: Use modules public directories to serve static assets
62+
- **loadingHTML**: Use a HTML file as a loading screen until the boot proccess finish. This can be overridden by a module.
63+
- Anything else...
Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
---
22
title: Installation
3-
description: Get started with Nuxt UI Pro documentation template.
3+
description: Get started with Reactmos.
44
navigation.icon: i-lucide-download
55
---
66

7-
::tip{target="_blank" to="https://content.nuxt.com/templates/docs"}
8-
Use this template on Nuxt Studio and start your documentation in seconds.
7+
::warning
8+
Reactmos is under heavy development. Use with caution.
99
::
1010

1111
## Quick Start
1212

1313
You can start a fresh new project with:
1414

1515
```bash [Terminal]
16-
npx nuxi init -t github:nuxt-ui-pro/docs
16+
pnpm create reactmos my-module
1717
```
1818

19-
or create a new repository from GitHub:
19+
or create a new project with:
2020

21-
1. Open <https://github.com/nuxt-ui-pro/docs>
22-
2. Click on `Use this template` button
23-
3. Enter repository name and click on `Create repository from template` button
24-
4. Clone your new repository
25-
5. Install dependencies with your favorite package manager
26-
6. Start development server
21+
1. Install `reactmos`: `pnpm add reactmos`
22+
2. Add `@reactmos/cli` as development dependency: `pnpm add -D @reactmos/cli`
23+
3. Add the scripts to `package.json`:
24+
```json
25+
"dev": "reactmox dev",
26+
"build": "reactmox build"
27+
```
28+
4. Create a configuration file in `src/module.config.ts`
29+
```ts
30+
export default {
31+
moduleName: 'my-module'
32+
}
33+
```
2734

28-
That's it! You can now start writing your documentation in the [`content/`](https://content.nuxt.com/usage/content-directory) directory 🚀
35+
That's it! You can now start writing your application!

0 commit comments

Comments
 (0)