From 9c60bd91467299383adf92e150804f97824ebe36 Mon Sep 17 00:00:00 2001 From: pratik naik Date: Tue, 11 Aug 2026 16:46:16 +0530 Subject: [PATCH] fix(docs): add Makefile local setup commands Signed-off-by: pratik naik --- Makefile | 11 +++++++++++ README.md | 17 ++++------------- 2 files changed, 15 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000..1c4d8f888b --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +.PHONY: setup serve build + +setup: + git submodule update --init --recursive + npm install + +serve: + hugo server -D + +build: + hugo diff --git a/README.md b/README.md index b690f37541..ed7c14a271 100644 --- a/README.md +++ b/README.md @@ -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