Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit c35b2fe

Browse files
committed
docs: update guide
1 parent 350358b commit c35b2fe

File tree

2 files changed

+13
-19
lines changed

2 files changed

+13
-19
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
11
# Nuxt Tutorial Playground
22

33
> [!WARNING]
4-
> This project is unfinished and heavily work in progress.
4+
> The architecture of this project is ready, while the tutorial content is still work in progress, contributions appreciated!
55
66
An interactive interactive tutorial and playground for learning Nuxt. Powered by [Nuxt](https://nuxt.com/docs) and [WebContainers](https://webcontainers.io/).
77

88
Inspired by [learn.svelte.dev](https://learn.svelte.dev).
99

10+
`learn.nuxt.com` is not yet deployed, but you can preview the latest branch at [learn-dev.nuxt.com](https://learn-dev.nuxt.com).
11+
1012
## Live Streaming
1113

12-
Anthony Fu is doing regular live streaming on building this project from scratch. You can watch the recordings or join the live stream on [YouTube](https://www.youtube.com/playlist?list=PL4ETc_mXFfxUGiY852jH3ctljnI2e9Rax).
14+
Anthony Fu built this project from scratch on Live Streaming. You can watch the recordings of the full process on [YouTube](https://www.youtube.com/playlist?list=PL4ETc_mXFfxUGiY852jH3ctljnI2e9Rax).
1315

1416
## Contributing
1517

16-
> [!IMPORTANT]
17-
>
18-
> **Please create an issue first before submitting PRs.**
19-
> So that we can discuss about the directions and plans, to avoid wasted efforts. Thank you!
20-
>
21-
> This project is progressed mainly on Live Stream. In general, we want to present the main progress on the stream so people can follow along the whole process. Contributions are still greatly welcome! For PR that makes refactors or big changes, we could review them on the stream as well.
22-
23-
## Development
18+
### Development
2419

2520
To run this project locally, you need to have [Node.js v20.0+](https://nodejs.org/en/) and [pnpm](https://pnpm.io/) installed.
2621

@@ -38,6 +33,14 @@ pnpm dev
3833

3934
The development server will be running at [http://localhost:3000](http://localhost:3000).
4035

36+
### Content Structure
37+
38+
The tutorial content is located in the `content/` directory. Each route contains a number prefix (`1.`) to indicate the order and will be removed in the final URL. For each route, we use a folder with an `index.md` to serve the extra files. A `.template` folder can be placed with the `index.md` file to provide the template for the playground.
39+
40+
- `.template/index.ts` - Indicates the metadata for that guide, like enabling/disabling features, file filters, etc.
41+
- `.template/files/**` - The files that will be copied to the playground when the user navigates to that guide, merged with the basic template under `template/basic/`
42+
- `.template/solutions/**` - Optional solutions for the tasks in that guide, merged with the guide files.
43+
4144
## Todolist
4245

4346
- [ ] Content

outline.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)