Skip to content

Commit 6c784e3

Browse files
authored
Update README.md
1 parent 3368605 commit 6c784e3

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,26 @@
3535

3636
<br>
3737

38-
<h2 align="center"> Building the Docs Site </h2>
38+
<h2 align="center"> Building the Docs Site with <a href="https://docusaurus.io/">Docusaurus 2.</a></h2>
39+
40+
<br>
3941

4042
<p align="center">
41-
The docs site is created using the static website generator <a href="https://docusaurus.io/">Docusaurus 2.</a> <br>
43+
<img height=150px src="static/img/undraw_docusaurus_react.svg"> <br>
4244
</p>
4345

44-
- This project has a hard dependancy on Node16. You will need to make sure that you have the proper version of node installed to avoid errors.
46+
### Pre-reqs
47+
48+
1. This project has a hard dependancy on Node16. You will need to make sure that you have the proper version of node installed to avoid errors.
4549

4650
- <a href="https://joshtronic.com/2021/05/09/how-to-install-nodejs-16-on-ubuntu-2004-lts/">Install Node16 on Ubuntu</a>
4751
- <a href="https://apple.stackexchange.com/a/207883">Install Node16 using brew</a>
4852

49-
- This project relies on yarn for package management. You will need to install yarn in order to build and test the documentation site.
53+
2. This project relies on yarn for package management. You will need to install yarn in order to build and test the documentation site.
5054

51-
- <a href="https://classic.yarnpkg.com/lang/en/docs/install"> Official yarn installation docs.</a>
55+
- <a href="https://classic.yarnpkg.com/lang/en/docs/install"> Official yarn installation docs.</a>
56+
57+
### Usage
5258

5359
1. Install project dependancies
5460

0 commit comments

Comments
 (0)