Prerequisite
- Know how to contribute
- Node.js, requires version >=18.0
- pnpm, requires version >=8.0
- Preferably a markdown editor, Here's a few: Visual studio code, Typora. (If not, any text editor is fine)
- Git
Step by step
Clone your forked repo:
git clone https://github.com/<You username>/dotcom
Start the dev environment:
Install dependencies:
npm install
Start the development server:
npm run dev
Now, the website should be running at http://localhost:3000. It will support live reload upon code changes.
Create corresponding markdown files under the
content
folder in the corresponding location.Note: If it's a whole new section you are adding:
Create the corresonding folder under
content
Add a
index.md
file inside you newly created folderCopy what you added in step 6. to the index.md
Replace the title in
##
with:--- title: <Your title> ---
Add your link into DOCS_NODES.
Enjoy writing!