Skip to content

Commit 45b2689

Browse files
authored
updated readme, removed yarn deps (#205)
Signed-off-by: Neelanjan Manna <[email protected]> Signed-off-by: Neelanjan Manna <[email protected]>
1 parent 77d5c91 commit 45b2689

File tree

3 files changed

+5
-31
lines changed

3 files changed

+5
-31
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ lib/core/MetadataBlog.js
99
docs/embedmd-command.sh
1010

1111
website/translated_docs
12-
website/yarn.lock
1312
website/node_modules
1413
website/build
1514
website/i18n/*

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ _Installation:_
4242
- Make sure you have [golang](https://github.com/golang/go) installed. We just need to run the following command to install embedmd.
4343

4444
```bash
45-
go get github.com/campoy/embedmd
45+
go install github.com/campoy/embedmd@latest
4646
```
4747

4848
_Run embedmd (needs to be done before commiting the changes):_
@@ -59,32 +59,15 @@ _Check the difference:_
5959
- Executing `embedmd -d docs-name.md` will display the difference between the contents of docs-name.md and the output of embedmd docs-name.md.
6060

6161
## Manual Setup
62-
63-
### Install Node.js
64-
65-
```bash
66-
sudo apt-get install software-properties-common
67-
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
68-
```
69-
70-
### Get the latest Node.js package
71-
72-
```bash
73-
sudo apt-get install -y nodejs
74-
```
75-
76-
### Install Yarn
77-
78-
```bash
79-
npm install -g yarn
80-
```
62+
### Pre-Requisites
63+
- Node.js 16.14 or above. It can be installed from [here](https://nodejs.org/en/download/).
8164

8265
### Start the server
8366

8467
```bash
8568
cd website
86-
yarn install
87-
yarn start
69+
npm install
70+
npm start
8871
```
8972

9073
## Using Docker compose

website/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,3 @@ npm run docusaurus docs:version <VERSION>
3232

3333
This command will tag a new version from master docs.
3434
It will copy the docs/ folder contents into a new versioned_docs/version-`<version>`/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-`<version>`-sidebars.json and append the new version number to versions.json.
35-
36-
## Deployment
37-
38-
```console
39-
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
40-
```
41-
42-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 commit comments

Comments
 (0)