Skip to content

Commit 193455b

Browse files
committed
add reading format example
1 parent 2ad74a8 commit 193455b

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ This serves as a content monorepo for all the readings of the backend bootcamp c
4141
- Each reading should begin with the title as an h1.
4242
- Below the title it should have the summary and learning goals.
4343
- After this goes in the main content of the reading.
44-
- Finally each reading should conclude with a section called Resources, where we can link the external blogs/tutorials/videos we referred to.
44+
- Finally each reading should conclude with a section called References, where we can link the external blogs/tutorials/videos we referred to.
4545

4646
## General Formatting Conventions
4747

@@ -55,4 +55,40 @@ This serves as a content monorepo for all the readings of the backend bootcamp c
5555
## Peer Review Process
5656
- Work on a module or reading on it's own branch and open a PR into main branch.
5757
- Request at least 2 reviewers on your PRs.
58-
- Open draft PRs early for large modules to get continuous peer reviews. This helps your peers know that the PR is still WIP and is also helpful to review the content in chunks.
58+
- Open draft PRs early for large modules to get continuous peer reviews. This helps your peers know that the PR is still WIP and is also helpful to review the content in chunks.
59+
60+
## Example
61+
62+
`Start with a H1 for the title`👇
63+
# Beginners guide to Node.js and NPM
64+
`Enter a quick summary and numbered list of learning objectives`👇<br/>
65+
We will be working in the Node.js and NPM environment throughout this bootcamp. The objectives of this lesson are:
66+
1. Understanding the Node.js framework
67+
2. Advantages of Node.js and why this course is focussed on Node.js
68+
69+
`Detail out first sub-topic under a H2`👇
70+
## Introduction to Node.js
71+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
72+
73+
`Detail out further sections with H3 inside the sub-topic`👇
74+
### Features of Node.js
75+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
76+
1. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
77+
2. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
78+
3. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
79+
80+
`Detail out next sub-topic under a H2`👇
81+
## Why are we teaching Node.js in this bootcamp?
82+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
83+
84+
`Use the end space of last section for a quick outro or recap of the reading.`👇<br/>
85+
Now that you have enough context on Node.js, let's prepare our coding environments on our computers. Coming up next is your first assignment of this course which will walk you through setting up your Node.js environment.
86+
87+
`End with a horizontal rule and list References under an H2`👇
88+
89+
---
90+
## References
91+
- https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/
92+
- https://nodejs.dev/learn/introduction-to-nodejs
93+
- https://medium.com/jspoint/how-javascript-works-in-browser-and-node-ab7d0d09ac2f
94+
- https://www.geeksforgeeks.org/top-8-reasons-to-learn-nodejs-in-2020/

0 commit comments

Comments
 (0)