Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hariesramdhani committed Aug 9, 2024
1 parent 07b37ba commit 0ca2b03
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<GITHUB_USERNAME> npm run deploy
```
5. Add, commit and push all changes
1. Add, commit and push all changes
```
git add .
git commit -m "<INSERT_YOUR_MESSAGE_HERE>"
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!
1. Wait the GitHub action to finish and it's live now on [MorganLab Wiki](https://morganresearchlab.github.io/Wiki/) thanks for contributing!

0 comments on commit 0ca2b03

Please sign in to comment.