An open API service indexing awesome lists of open source software.

https://github.com/devprabal/notes

personal note-taking
https://github.com/devprabal/notes

notes

Last synced: 3 months ago
JSON representation

personal note-taking

Awesome Lists containing this project

README

          

# devpogi notes

*My learnings on various subjects.*

## List

- [brave_browser](brave_browser/brave_browser_notes.md)
- [c](c/c_notes.md)
- [clang-format](clang-format/clang-format_notes.md)
- [code_review](code_review/code_review_notes.md)
- [counting-numbers-en-ko-hi](counting-numbers-en-ko-hi/counting-numbers-en-ko-hi_notes.md)
- [cpp](cpp/cpp_notes.md)
- [git](git/git_notes.md)
- [linux](linux/linux_notes.md)
- [my_repos](my_repos/my_repos_notes.md)
- [rpi](rpi/rpi_notes.md)
- [semaphore](semaphore/semaphore_notes.md)
- [vim](vim/vim_notes.md)
- [windows](windows/windows_notes.md)

## How to build this repo?

```bash
docker build -t notes-builder .
docker run --rm -i -v "$PWD":/app notes-builder make
```

## How to add new docs?

Suppose you want to add a new notes dir (say) - `kawaii_tech`.
Then this dir `kawaii_tech` should have the following structure and mandatory files (notice the naming of the files too) -

`kawaii_tech/kawaii_tech_notes.md`

`kawaii_tech_notes.md` is the file in which your markdown content goes.
Now in the `Makefile` (of the project's root dir) add this dir to `DIRS_UNSORTED` variable.

> Tip: You must start your content with a level 1 heading (`# something`) otherwise, the first para is lost in the render.