Skip to content

Commit

Permalink
fix: formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
0xs34n committed Mar 7, 2022
1 parent 1ee6f65 commit 248246f
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 4 deletions.
29 changes: 25 additions & 4 deletions www/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ const config = {
organizationName: '0xs34n', // Usually your GitHub org/user name.
projectName: 'starknet.js', // Usually your repo name.

plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'guides',
path: 'guides',
routeBasePath: 'guides',
sidebarPath: require.resolve('./sidebars.js'),
},
],
],

presets: [
[
'classic',
Expand Down Expand Up @@ -51,9 +63,14 @@ const config = {
items: [
{
type: 'doc',
docId: 'intro',
docId: 'API/index',
position: 'left',
label: 'Tutorial',
label: 'API',
},
{
position: 'left',
label: 'Guides',
to: '/guides/intro'
},
{to: '/blog', label: 'Blog', position: 'left'},
{
Expand All @@ -70,8 +87,12 @@ const config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
label: 'API',
to: '/docs/API/',
},
{
label: 'Guides',
to: '/guides/intro',
},
],
},
Expand Down
41 changes: 41 additions & 0 deletions www/guides/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1
---

# Getting Started

Let's discover **StarkNet.js in less than 5 minutes**.

### What you'll need

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

## Generate a new site

Generate a new Docusaurus site using the **classic template**.

The classic template will automatically be added to your project after you run the command:

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

0 comments on commit 248246f

Please sign in to comment.