Skip to content

Commit

Permalink
set only document mode
Browse files Browse the repository at this point in the history
  • Loading branch information
farhoud.m7 committed May 23, 2024
1 parent 192988c commit 27a88e2
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 82 deletions.
1 change: 1 addition & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
slug: /
---

# Tutorial Intro
Expand Down
48 changes: 48 additions & 0 deletions docs/market.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1

---

# Tutorial Intro

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

## Getting Started

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

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.

### 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

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.
13 changes: 4 additions & 9 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,14 @@ const config: Config = {
'classic',
{
docs: {
routeBasePath: '/',
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: false,
theme: {
customCss: './src/css/custom.css',
},
Expand Down Expand Up @@ -86,8 +81,8 @@ const config: Config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/docs/intro',
label: 'Market',
to: '/docs/market',
},
],
},
Expand Down
23 changes: 0 additions & 23 deletions src/pages/index.module.css

This file was deleted.

43 changes: 0 additions & 43 deletions src/pages/index.tsx

This file was deleted.

7 changes: 0 additions & 7 deletions src/pages/markdown-page.md

This file was deleted.

0 comments on commit 27a88e2

Please sign in to comment.