notes/index.html at main · devprabal/notes · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="author" content="devpogi" />
<link rel="stylesheet" href="style.css" />
<meta name="description" content="devprabal's personal note-taking website">
<meta property="og:url" content="https://devprabal.github.io/notes/">
<meta property="og:type" content="website">
<meta property="og:title" content="devpogi notes">
<meta property="og:description" content="devprabal's personal note-taking website">
<meta property="og:image" content="https://devprabal.github.io/notes/notes_github_cover.png">
<meta name="twitter:card" content="summary_large_image">
<meta property="twitter:domain" content="devprabal.github.io">
<meta property="twitter:url" content="https://devprabal.github.io/notes/">
<meta name="twitter:title" content="devpogi notes">
<meta name="twitter:description" content="devprabal's personal note-taking website">
<meta name="twitter:image" content="https://devprabal.github.io/notes/notes_github_cover.png">
<title>devpogi notes</title>
</head>
<body>
<header>
    <a href="./index.html">Home</a>
</header><h1 id="devpogi-notes">devpogi notes</h1>

<p><em>My learnings on various subjects.</em></p>

<h2 id="list">List</h2>

<ul>
<li><a href="brave_browser/brave_browser_notes.html">brave_browser</a></li>
<li><a href="c/c_notes.html">c</a></li>
<li><a href="clang-format/clang-format_notes.html">clang-format</a></li>
<li><a href="code_review/code_review_notes.html">code_review</a></li>
<li><a href="counting-numbers-en-ko-hi/counting-numbers-en-ko-hi_notes.html">counting-numbers-en-ko-hi</a></li>
<li><a href="cpp/cpp_notes.html">cpp</a></li>
<li><a href="git/git_notes.html">git</a></li>
<li><a href="linux/linux_notes.html">linux</a></li>
<li><a href="my_repos/my_repos_notes.html">my_repos</a></li>
<li><a href="rpi/rpi_notes.html">rpi</a></li>
<li><a href="semaphore/semaphore_notes.html">semaphore</a></li>
<li><a href="vim/vim_notes.html">vim</a></li>
<li><a href="windows/windows_notes.html">windows</a></li>
</ul>

<h2 id="how-to-build-this-repo">How to build this repo?</h2>

<pre><code class="language-bash">docker build -t notes-builder .
docker run --rm -i -v "$PWD":&#47;app notes-builder make
</code></pre>

<h2 id="how-to-add-new-docs">How to add new docs?</h2>

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

<p><code>kawaii_tech&#47;kawaii_tech_notes.html</code></p>

<p><code>kawaii_tech_notes.html</code> is the file in which your markdown content goes.<br/>
Now in the <code>Makefile</code> (of the project&#8217;s root dir) add this dir to <code>DIRS_UNSORTED</code> variable.  </p>

<blockquote>
<p>Tip: You must start your content with a level 1 heading (<code># something</code>) otherwise, the first para is lost in the render.   </p>
</blockquote>
</body>
</html>