Prerequisite
- 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
- Know how to contribute
Step by step
Clone your forked repo:
git clone https://github.com/<You username>/dotcom
Change to the directory:
cd dotcom
If you want to see you new docs live on your localhost:
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.
Go to
consts
folder and open upauthor.ts
.Add you name and links under the
const authorList: Author[]
section in the following format:{ name: "Your name", email: "Your email", //optional url: "Your website link", //optional github: "Your github usename", //optional twitter: "Your twitter handle", //optional funding: "Your funding link", //optional },
Go to
content/docs/
and open upindex.md
.Add the name and link of you document in the desired section.
Note: If it's a single document with no relation to existing section, add it to the
Others
section. If it's a serveral document requiring a new section, create a new section using the markdown's headings 2.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 this on top you makrdown file, change the variables accordingly:
--- title: <Your title> author: <You name(the one you just put in author.ts)> ---
Enjoy writing you documentation!