You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
refactor(README): refine formatting and overhaul content (#26)
* refactor(README): refine formatting and overhaul content
* fix(docs): use correct link for deploy action
---------
Co-authored-by: Daniel Rudnitski <danielrudn@gmail.com>
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3
+
## Development
4
4
5
-
### Installation
5
+
### Adding content
6
6
7
-
```
8
-
$ yarn
9
-
```
10
-
11
-
### Local Development
7
+
We use [Docusaurus](https://docusaurus.io/) within these docs.
12
8
13
-
```
14
-
$ yarn start
15
-
```
9
+
- You can find a [general set of guides to Docusaurus here](https://docusaurus.io/docs/category/guides).
10
+
-**Docusaurus provides extra cool formatting features** on top of vanilla Markdown,
11
+
see the [guide to these features here](https://docusaurus.io/docs/markdown-features).
16
12
17
-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
13
+
### Running the server
18
14
19
-
### Build
15
+
Install deps and run the dev server locally by running:
20
16
21
-
```
22
-
$ yarn build
17
+
```sh
18
+
yarn
19
+
yarn start
23
20
```
24
21
25
-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26
-
27
-
### Deployment
22
+
Most changes are reflected live without having to restart the server.
28
23
29
-
Using SSH:
24
+
## Building
30
25
31
-
```
32
-
$ USE_SSH=true yarn deploy
26
+
```sh
27
+
yarn build
33
28
```
34
29
35
-
Not using SSH:
30
+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
36
31
37
-
```
38
-
$ GIT_USER=<Your GitHub username> yarn deploy
39
-
```
32
+
## Deploying
40
33
41
-
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.
34
+
- Deploying to GitHub Pages occurs automatically upon merges to `main`.
35
+
- Check the [list of all `Deploy to GitHub Pages` workflow runs](https://github.com/ibm-skills-network/portals-admin-knowledgebase/actions/workflows/deploy.yml) to ensure your changes are successfully deployed after they're merged.
0 commit comments