Skip to content

Commit

Permalink
Start adding content
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-blueguardianco committed Jan 24, 2024
1 parent cf186bb commit 4cb5999
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 34 deletions.
40 changes: 9 additions & 31 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,22 @@ sidebar_position: 1

# Tutorial Intro

Let's discover **Docusaurus in less than 5 minutes**.
Let's discover **Tracker in less than 5 minutes**.

## Getting Started

Get started by **creating a new site**.

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
Get started by **registering a new device**.

### What you'll need

- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

## Generate a new site
- The serial number associated with your device
- This is located on the back of your device, and will also be displayed on the screen during startup/power on.

Generate a new Docusaurus site using the **classic template**.
## Register your device

The classic template will automatically be added to your project after you run the command:
Follow the **WEB UI** prompts, or:
Use the chat based command line interface

```bash
npm init docusaurus@latest my-website classic
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

## Start your site

Run the development server:

```bash
cd my-website
npm run start
```

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.

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/.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
device register <serial-number>
```
6 changes: 3 additions & 3 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
Tracker Application Documentation
</Link>
</div>
</div>
Expand All @@ -32,8 +32,8 @@ export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
title={`${siteConfig.title}`}
description="BlueGuardian Co Home Page">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down

0 comments on commit 4cb5999

Please sign in to comment.