From 0ca2b034b170169c463979f1d50c1ff0cffb7f78 Mon Sep 17 00:00:00 2001 From: hariesramdhani Date: Fri, 9 Aug 2024 14:27:21 +0100 Subject: [PATCH] Updated README.md --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7b2e7e7..aad8674 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,15 @@ Contributing is very easy even when you have limited programming knowledge! ```bash git clone https://github.com/MorganResearchLab/wiki.git ``` -2. All of the posts are located in the `docs` folder, creating new folder inside of it will create a new category in the sidebar. Creating a markdown file (`.md`, `.mdx`) or React component (`.jsx`) will create a new post. More on [Docusaurus guides](https://docusaurus.io/docs/category/guides) -3. To preview how the wiki looks like after you add something to the `docs` folder. You have to make sure you have Node.js and Node Package Manager installed, otherwise you can skip step 3 and 4 +1. All of the posts are located in the `docs` folder, creating new folder inside of it will create a new category in the sidebar. Creating an `.md` or React component (`.jsx`) will create a new post. More on [Docusaurus guides](https://docusaurus.io/docs/category/guides) +1. To preview how the wiki looks like after you add something to the `docs` folder. You have to make sure you have Node.js and Node Package Manager installed, otherwise you can skip step 3 and 4 ``` npm run dev ``` -4. If you're happy with how it looks like, you can generate the github page for the deployment - ``` - GIT_USER= npm run deploy - ``` -5. Add, commit and push all changes +1. Add, commit and push all changes ``` git add . git commit -m "" git push ``` -6. It's live now on [MorganLab Wiki](https://morganresearchlab.github.io/Wiki/) (if you do step 3 and 4, otherwise wait for Haries to generate it for you), thanks for contributing! \ No newline at end of file +1. Wait the GitHub action to finish and it's live now on [MorganLab Wiki](https://morganresearchlab.github.io/Wiki/) thanks for contributing! \ No newline at end of file