Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Davidakanmu authored Jul 1, 2024
1 parent 0856cab commit f69f004
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

## Install dependencies
In the root folder and install the dependencies before continuing.

```
npm install
```

## Start the development server
To preview your work locally and automatically refreshes your browser when you make changes.

Inside your project folder, run the following command to start the development server:

```
npm run dev
```

## Add pages
Add new pages to your site by creating .md or .html files in content/docs/. Use sub-folders to organize your files and to create multiple path segments.

For example, the following command will generate a page at example.com/docs/guides/faq:

```
npm run create docs/guides/faq.md
```

## Build project
To build your project, run the following command:

```
hugo
```

Or

```
npm run build
```

0 comments on commit f69f004

Please sign in to comment.