Welcome to DevNotes

DevNotes is a Jekyll based template for quickly creating a note making platform for developers.

A developer’s note is different than the general note which contains mostly text. The note of a developer contains code snippet, multimedia like images and video, hyperlinks etc.

This template will help you create your own note making platform.

Note with code snippet

The most general form of note is the one which contain any code snippet.

For example, if you are writing a note which has some text and code snippet and you want to share with your friends.

Then, you can write such note through this platform as:

I was working on some code and found following code snippet interesting.

```c
#include <stdio.h>

int main() {
  printf("Namaste, DevNotes!");
}
```

This program has no return statement and it is still working.
Magic!

This platform will render the code snippet of above note as below with grey background:

#include <stdio.h>

int main() {
  printf("Namaste, DevNotes!");
}

The another format for code snippet is using highlight block as below:

{% highlight c %}
#include <stdio.h>

int main() {
  printf("Namaste, DevNotes!");
}
{% endhighlight %}

The benefit of using highlight syntax is that we can specify line numbers as well like below:

{% highlight c linenos %}
#include <stdio.h>

int main() {
  printf("Namaste, DevNotes!");
}
{% endhighlight %}

The result is :

1
2
3
4
5
#include <stdio.h>

int main() {
  printf("Namaste, DevNotes!");
}

Customizations

To customize your notes, you need to have basic understanding of Jekyll which is very easy framework to learn and would be easy if you already know about HTML, CSS and JavaScript.

Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll.

Bugs or Feature request

If you found any bug or have feature request, consider checking the GitHub repo and file an issue.

Happy note making!