Giter Club home page Giter Club logo

learn.nuxt.com's Introduction

Nuxt Tutorial Playground

Warning

The architecture of this project is ready, while the tutorial content is still work in progress, contributions appreciated!

An interactive interactive tutorial and playground for learning Nuxt. Powered by Nuxt and WebContainers.

Inspired by learn.svelte.dev.

learn.nuxt.com is not yet deployed, but you can preview the latest branch at learn-dev.nuxt.com.

Live Streaming

Anthony Fu built this project from scratch on Live Streaming. You can watch the recordings of the full process on YouTube.

Contributing

Development

To run this project locally, you need to have Node.js v20.0+ and pnpm installed.

After cloning the repo, run the following commands to install dependencies:

pnpm install

Then, run the following command to start the development server:

pnpm dev

The development server will be running at http://localhost:3000.

Content Structure

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.

  • .template/index.ts - Indicates the metadata for that guide, like enabling/disabling features, file filters, etc.
  • .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/
  • .template/solutions/** - Optional solutions for the tasks in that guide, merged with the guide files.

Todolist

  • Content
    • Allow each guide to configure file filter
    • Persist user changes when toggling solutions
    • Verification for tutorial tasks
    • Search feature
      • Search in command palette
      • Search button
    • Navigation
      • Dropdown for guide outlines
      • Breadcrumbs
      • Previous/Next buttons
    • Embedded Nuxt Docs (update CORS headers)
    • Only make necessary changes when navigating between guides
    • Switch playgrounds on different guides
    • Allow each guide to toggle features
    • Solution for each guide
    • A button of "Edit this page"
  • SEO
    • OG Image
    • Meta tags
    • Sitemap
  • Command K System
  • About Page
  • Welcome Screen
  • Try https://ark-ui.com/docs/components/splitter
  • Show release time for the playground
  • Show Nuxt and Vue versions from the container
  • Custom bundler for templates (replaces import.meta.glob, create static virtual modules)
  • Monaco editor and Volar
    • Connection Volar to the WebContainer FS
  • File tree
  • Add interactivity shell
  • A basic editor
  • Refactor logic from Vue SFC to composables
  • Refactor to add Pinia
  • Frame-to-parent communication
  • Sync the basic style
  • Buttons to restart server
  • Open/close terminal panel
  • Extract "playground injected" utils
  • Download the project as zip

License

MIT

learn.nuxt.com's People

Contributors

antfu avatar serkodev avatar renovate[bot] avatar hometownsocool avatar lmmmmmm-bb avatar a1mersnow avatar sqcheah avatar cherishtheyouth avatar artsmp0 avatar aj-2000 avatar zyyv avatar posva avatar erjanmx avatar userquin avatar l4dybird avatar rpiechowicz avatar sifferhans avatar soya-xy avatar hyoban avatar yjl9903 avatar kunish avatar starknt avatar xrexy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.