Taking Notes And Writing Like A Developer

Many ways to keep notes and write about code. This is how I do it.

TODO

create a Workspace/notes directory for daily notes

open notes/ folder in vscode

create a markdown file *.md for todays notes

• TIL
• TODOs
• links
• meeting notes
• timesheet / schedule

Why?

need a place to track your learning, links, meeting notes, schedule, todos, etc.

README and technical documentation are often written in markdown

piazza, slack, github, stack overflow and many other websites support markdown

Markdown

https://www.markdownguide.org/

Any file ending in *.md or *.markdown

vscode

automagically supports markdown

command + shift + v to view markdown preview in vscode

Heading

# H1
## H2
### H3

H1

H2

H3

List

* First item
* ~~Second item~~
* Third item

• First item
• Second item
• Third item

Link

[Google](https://google.com)

Google

Code

<!-- 1 liner -->
`<h1>Hello World</h1>`

<!-- multi line -->
```ruby
def my_method
  puts 'Hello'
end

<h1>Hello World</h1>

def my_method
  puts 'Hello'
end

# time
* 830-915 worked on treehouse hashes
* 915-930 stand up
* 930-1030 linkedin profile peer review

# links
https://www.markdownguide.org/cheat-sheet/


# todo
* ~~finish treehouse hashes~~
* update linkedin profile
* add linkedin link to my github.io page

time

• 830-915 worked on treehouse hashes
• 915-930 stand up
• 930-1030 linkedin profile peer review

links

https://www.markdownguide.org/cheat-sheet/

todo

• finish treehouse hashes
• update linkedin profile
• add linkedin link to my github.io page

Resources

Cheatsheet
Try out markdown online
Markdown Essentials