Skip to content

fix: add Makefile local setup commands #4454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pratik-naik003 wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −13
Open

fix: add Makefile local setup commands #4454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.PHONY: setup serve build

setup:
git submodule update --init --recursive
npm install

serve:
hugo server -D

build:
hugo
17 changes: 4 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,25 +96,16 @@ Follow the usual GitHub workflow of forking the repository on GitHub and then cl
3. Initialize the Docsy submodule:

```bash
git submodule update --init --recursive
make setup
```

4. Install Docsy dependencies:
4. Start your local Hugo server:

```bash
# install the node packages (at the root of the repo)
# NOTE: ensure you have node 18 installed, possibly using nvm
npm install
make serve
```

5. Start your local Hugo server:

```bash
# NOTE: You should ensure that you are in the root directory of the repository.
hugo server -D
```

6. You can access your website at [http://localhost:1313/](http://localhost:1313/)
5. You can access your website at [http://localhost:1313/](http://localhost:1313/)

### Useful docs

Expand Down