Skip to content

HunorMarton/svg-tutorial

Repository files navigation

SVG-Tutorial.com

This repo contains the source code of SVG-Tutorial.com. While it generally follows the structure of an Astro project, it has three main parts with slightly different approaches.

Tutorials

Tutorial pages like How to Draw Basic Paths with SVG have their content as MDX files in the /src/content/svg/ folder, with supporting files, among others, in the /svg/components/markdown/ folder.

Summary Page

The Summary page's content is an MDX file in the /src/pages/summary folder, with supporting files, among others, in the /svg/components/summary folder.

Editors

The editor pages, such as the Arc editor, the interactive embeds within the tutorial, and the summary page, use React and Redux Toolkit. They mainly live in the /src/svg-curves folder. The editors are an updated version of a previous project.


Astro

This directory is a brief example of an Astro site that can be deployed to Vercel with zero configuration. This demo showcases:

Learn more about Astro on Vercel.

Deploy Your Own

Deploy your own Astro project with Vercel.

Deploy with Vercel

Live Example: https://astro-template.vercel.app

Project Structure

Astro looks for .astro, .md, or .js files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components or layouts.

Any static assets, like images, can be placed in the public/ directory.

Commands

All commands are run from the root of the project, from a terminal:

Command Action
pnpm install Installs dependencies
pnpm run dev Starts local dev server at localhost:3000
pnpm run build Build your production site to ./dist/
pnpm run preview Preview your build locally, before deploying
pnpm run start Starts a production dev server at localhost:3000
pnpm run astro ... Run CLI commands like astro add, astro preview
pnpm run astro --help Get help using the Astro CLI