How to use this research Journal

Each day a new post is added as a way to journal my research. The goal is to keep a record of images generated that day, import lines of code in my python scripts or in shell and what is accomplished and what needs to be worked on. These posts are generated via Jekyll.

Files of the blog are located in /GDF/gf_research_journal/

$ jekyll build
$ bundle exec jekyll serve

To then view with a browser, go to http://127.0.0.1:4000/

This journal is written in either markdown, or html.

Markdown Cheetsheet

Use with Atom

Atom with Jekyll

In Atom:
Toggle Server command Alt-Shift-T
Start new post file or Journal Entry Cmd-Alt-J

Edits to Jekyll for this Research Journal

  • Added Categories Tags to each post page in _layouts/post.html
  • Added Categories Page to be able to search common categories
  • Added Date, Author, and Categories Icons in _layouts/post.html using Font Awesome
  • Changed Colors to a dark theme in scss files: _sass/minina.scss. Used Ctrl+Shft+C in browser to find element of code and then edit scss files.

Inserting Images

Local Images

TA Map Middle Drum Site Caption

Markdown code :

![TA](/assets/20190212/test.jpg "Middle Drum")
*Middle Drum Site Caption*

Resize and Center

HTML code :

<center><img src="/assets/20190212/test.jpg" width="400" align="middle"></center>

place figures in assets/ dir.

Hyper-linked Images

alt text

Markdown code :

![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/assets/icon48.png "Logo Title Text 1")

Inserting Code

Example Python Code

s = "Python syntax highlighting"
print s

Markdown code :

```python
s = "Python syntax highlighting"
print s
```

Example Shell Code

command0_help() {
  echo "The following commands with required arguments, are available:"
  cat $0 | grep '^command[0-9]_.*#' | sed 's/^command\([0-9]\)_\(.*\)() { #\(.*\)/\2:\3/' | sort
}

Markdown code :

``` shell
command0_help() {
  echo "The following commands with required arguments, are available:"
  cat $0 | grep '^command[0-9]_.*#' | sed 's/^command\([0-9]\)_\(.*\)() { #\(.*\)/\2:\3/' | sort
}
```

Inserting Jupyter Code

Export notebook as markdown and html. Take figures <img src=…> and copy and paste into markdown file. Then you don’t have to worry about images not transfering.

Example Loading a jupyter notebook exported to markdown: