From 7d20194d8ae9b600936e47826de53eb4f75e58e1 Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Tue, 4 Oct 2022 21:38:58 -0700 Subject: [PATCH] [docs] create getting started guide outside blog (#7812) --- CONTRIBUTING.md | 2 +- site/content/docs/01-getting-started.md | 21 +++++++++++++++++++ ...onent-format.md => 02-component-format.md} | 0 ...mplate-syntax.md => 03-template-syntax.md} | 0 .../docs/{03-run-time.md => 04-run-time.md} | 0 ...{04-compile-time.md => 05-compile-time.md} | 0 ...rnings.md => 06-accessibility-warnings.md} | 0 .../01-introduction/01-basics/text.md | 2 +- .../19-next-steps/01-congratulations/text.md | 2 +- 9 files changed, 24 insertions(+), 3 deletions(-) create mode 100644 site/content/docs/01-getting-started.md rename site/content/docs/{01-component-format.md => 02-component-format.md} (100%) rename site/content/docs/{02-template-syntax.md => 03-template-syntax.md} (100%) rename site/content/docs/{03-run-time.md => 04-run-time.md} (100%) rename site/content/docs/{04-compile-time.md => 05-compile-time.md} (100%) rename site/content/docs/{05-accessibility-warnings.md => 06-accessibility-warnings.md} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7989caeea..816faf31aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ The [Open Source Guides](https://opensource.guide/) website has a collection of There are many ways to contribute to Svelte, and many of them do not involve writing any code. Here's a few ideas to get started: -- Simply start using Svelte. Go through the [Getting Started](https://svelte.dev/blog/the-easiest-way-to-get-started) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues). +- Simply start using Svelte. Go through the [Getting Started](https://svelte.dev/docs#getting-started) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues). - Look through the [open issues](https://github.com/sveltejs/svelte/issues). A good starting point would be issues tagged [good first issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests). - If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). - Read through our [tutorials](https://svelte.dev/tutorial/basics). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit this chapter" at the bottom left of the tutorial page. diff --git a/site/content/docs/01-getting-started.md b/site/content/docs/01-getting-started.md new file mode 100644 index 0000000000..b8119390f4 --- /dev/null +++ b/site/content/docs/01-getting-started.md @@ -0,0 +1,21 @@ +--- +title: Getting started +--- + +--- + +To try Svelte in an interactive online environment you can try [the REPL](https://svelte.dev/repl) or [StackBlitz](https://node.new/svelte). + +To create a project locally, run: +``` +npm create vite@latest myapp -- --template svelte +cd myapp +npm install +npm run dev +``` + +Or use [SvelteKit](https://kit.svelte.dev/), the official application framework from the Svelte team (currently in beta). + +See the SvelteSociety website run by the Svelte community for a list of integrations with various [tooling and editots](https://sveltesociety.dev/tools). + +If you're having trouble, get help on [Discord](https://svelte.dev/blog/chat) or [StackOverflow](https://stackoverflow.com/questions/tagged/svelte). diff --git a/site/content/docs/01-component-format.md b/site/content/docs/02-component-format.md similarity index 100% rename from site/content/docs/01-component-format.md rename to site/content/docs/02-component-format.md diff --git a/site/content/docs/02-template-syntax.md b/site/content/docs/03-template-syntax.md similarity index 100% rename from site/content/docs/02-template-syntax.md rename to site/content/docs/03-template-syntax.md diff --git a/site/content/docs/03-run-time.md b/site/content/docs/04-run-time.md similarity index 100% rename from site/content/docs/03-run-time.md rename to site/content/docs/04-run-time.md diff --git a/site/content/docs/04-compile-time.md b/site/content/docs/05-compile-time.md similarity index 100% rename from site/content/docs/04-compile-time.md rename to site/content/docs/05-compile-time.md diff --git a/site/content/docs/05-accessibility-warnings.md b/site/content/docs/06-accessibility-warnings.md similarity index 100% rename from site/content/docs/05-accessibility-warnings.md rename to site/content/docs/06-accessibility-warnings.md diff --git a/site/content/tutorial/01-introduction/01-basics/text.md b/site/content/tutorial/01-introduction/01-basics/text.md index 08ba922b42..c0a2b9eba0 100644 --- a/site/content/tutorial/01-introduction/01-basics/text.md +++ b/site/content/tutorial/01-introduction/01-basics/text.md @@ -4,7 +4,7 @@ title: Basics Welcome to the Svelte tutorial. This will teach you everything you need to know to build fast, small web applications easily. -You can also consult the [API docs](/docs) and the [examples](/examples), or — if you're impatient to start hacking on your machine locally — the [60-second quickstart](/blog/the-easiest-way-to-get-started). +You can also consult the [API docs](/docs) and the [examples](/examples), or — if you're impatient to start hacking on your machine locally — the [60-second quickstart](/docs#getting-started). ## What is Svelte? diff --git a/site/content/tutorial/19-next-steps/01-congratulations/text.md b/site/content/tutorial/19-next-steps/01-congratulations/text.md index 5b8256463e..1b4b13d4ab 100644 --- a/site/content/tutorial/19-next-steps/01-congratulations/text.md +++ b/site/content/tutorial/19-next-steps/01-congratulations/text.md @@ -4,7 +4,7 @@ title: Congratulations! You've now finished the Svelte tutorial and are ready to start building apps. You can refer back to individual chapters at any time (click the title above to reveal a dropdown) or continue your learning via the [API reference](/docs), [Examples](/examples) and [Blog](/blog). If you're a Twitter user, you can get updates via [@sveltejs](https://twitter.com/sveltejs). -To get set up in your local development environment, check out [the quickstart guide](/blog/the-easiest-way-to-get-started). +To get set up in your local development environment, check out [the quickstart guide](/docs#getting-started). If you're looking for a more expansive framework that includes routing, server-side rendering and everything else, take a look at [SvelteKit](https://kit.svelte.dev).