From f69f004949e48041878747de9da6422e0e24a3a2 Mon Sep 17 00:00:00 2001 From: Davidakanmu Date: Mon, 1 Jul 2024 21:16:51 +0100 Subject: [PATCH] Create README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..40030c6 --- /dev/null +++ b/README.md @@ -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 +```