For authors
General guidelines
- To post here, you should work or intern at HAMK Smart Research Unit.
- The open research diary is for anything that can be completely public the moment you write it, so no company projects or embargoed research.
- This is not an official HAMK channel at this stage, but hopefully it improves our notekeeping, information flow between us and to outside viewers (via Google).
- The site runs on GitHub Pages under
hamk-uas
, using Jekyll using the Primer theme with some modifications.
- To edit, you need write access to https://github.com/hamk-uas/HAMK-Smart-open-research-diary.
- Starting from the front page:
- Add yourself as an author.
- Add your project or subject as a tag or use an existing tag.
- Create a post and tag it.
- Check that the page has compiled at: https://github.com/hamk-uas/HAMK-Smart-open-research-diary/settings/pages.
- Congratulations, your post is now public!
- On the post’s page there will now be helpers for uploading post-specific assets such as images and for adding them to the page.
Markdown
Unless otherwise mentioned, the following will also work in GitHub preview.
Images
Figure 1. Example image
Math
MathJax support is included. If this is a problem on your page, we can add a way to disable it.
Unfortunately GitHub preview doesn’t render the math.
Inline math \(a^2 + b^2 = c^2\).
Equation:
\[a^2 + b^2 = c^2\tag{1}\]
Code
Inline code a^2 + b^2 + c^2
.
Highlighted code block:
int main() {
int i;
generateTable();
/* Printout */
for (i = 0; i < 1025; i++) {
printf("%d\t%d\n", i, sineTable[i]);
}
return 0;
}
Block diagrams
flowchart TB
A & B--> C & D
Figure 2. A block diagram using Mermaid.
JavaScript
matter.js simulation using JavaScript. This will not show in GitHub preview.