Mirror of https://forge.levinkeller.de/levin/dorfarchiv.git
141ee6795164aa968880489dbc53a69a6c10e1c8
| 1 | --- |
| 2 | sidebar_position: 1 |
| 3 | --- |
| 4 | |
| 5 | # Tutorial Intro |
| 6 | |
| 7 | Let's discover **Docusaurus in less than 5 minutes**. |
| 8 | |
| 9 | ## Getting Started |
| 10 | |
| 11 | Get started by **creating a new site**. |
| 12 | |
| 13 | Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. |
| 14 | |
| 15 | ### What you'll need |
| 16 | |
| 17 | - [Node.js](https://nodejs.org/en/download/) version 18.0 or above: |
| 18 | - When installing Node.js, you are recommended to check all checkboxes related to dependencies. |
| 19 | |
| 20 | ## Generate a new site |
| 21 | |
| 22 | Generate a new Docusaurus site using the **classic template**. |
| 23 | |
| 24 | The classic template will automatically be added to your project after you run the command: |
| 25 | |
| 26 | ```bash |
| 27 | npm init docusaurus@latest my-website classic |
| 28 | ``` |
| 29 | |
| 30 | You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. |
| 31 | |
| 32 | The command also installs all necessary dependencies you need to run Docusaurus. |
| 33 | |
| 34 | ## Start your site |
| 35 | |
| 36 | Run the development server: |
| 37 | |
| 38 | ```bash |
| 39 | cd my-website |
| 40 | npm run start |
| 41 | ``` |
| 42 | |
| 43 | The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. |
| 44 | |
| 45 | The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. |
| 46 | |
| 47 | Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. |