https://github.com/paatre/notes

https://github.com/paatre/notes

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/paatre/notes
• Owner: paatre
• Created: 2023-10-23T20:29:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T17:23:31.000Z (4 months ago)
• Last Synced: 2024-09-16T21:29:00.545Z (4 months ago)
• Size: 401 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Notes stash

These are my private (at least for now) notes that I'll keep on growing to understand the stuff I'm trying to learn. I want to write things on these notes so that it makes me remember them better and to come back to them later. Future me says "thanks!"

## Style guide

These notes are done in Markdown.

### Text width and resizing

Don't cut down long paragraphs to support proper automatic resizing of the paragraphs. This is why `textwidth` setting isn't set in my `~/.vimrc`:

```vim

augroup vimrcEx

  au!

  autocmd FileType * if &filetype != 'markdown' | setlocal textwidth=78 | endif

augroup END

```

### Headings

Always, I mean ALWAYS, use proper heading hierarchy: h1 > h2 > h3 > ...

### Text formatting

Use stars (`*`) for normal text formatting (*italic* and **bold**).

### List items

Use dashes (`-`) for list items.

---

© 2023 Teemu Viikeri