(Internal) Dev Reference

  1. Common Tasks
  2. Element Reference
  3. Todo

Common Tasks

Live Website Preview

./start.sh

Starts a local web server using port 4000 that auto-reloads on each change. See the script for the exact commands being run.

Warning

If _config.yml or a .rb file is edited, you must manually reload to apply the changes.

Writing and Editing Posts

Use StackEdit to edit any posts marked as WIP. Then, when you have time, start a local development server (see above), go to this site’s local admin page, and copy those posts over. Finally, commit and push the changes onto Github.

Optimize Images

$ image_optim --no-svgo --no-pngout -v *.{jpg,png}

Also consider resizing images! (Open in Preview, Tools -> Adjust Size) If you want, you can change the path name to prevent already optimized images from being processed again.

Element Reference

See this page.

Code Blocks

```python
print("Hello Markdown!")
```

If you want line numbers:

{% highlight python linenos %}
a = 1
b = 2
print(a + b)
{% endhighlight %}

Outputs:

print("Hello Markdown!")

1
2
3

a = 1
b = 2
print(a + b)

Replace python with your language name.

Note

{% highlight python %} without linenos is equivalent to Markdown’s triple backtick syntax.

Alerts

{% alert review %}
Sample `review` alert

With *multiple* **lines** and formatting!
{% endalert %}

Output:

Review

Sample review alert

With multiple lines and formatting!

Alert Types

Valid types (examples shown below): note, warning, danger, review, tip, important

Note

This is a note alert.

Warning

This is a warning alert.

Danger

This is a danger alert.

Review

This is a review alert.

Tip

This is a tip alert.

Important

This is an important alert.

This is a blank alert (no type supplied).

Uses a simple custom plugin in _plugins/alert.rb.

Icons

List of Font Awesome v4 icons: https://fontawesome.com/v4/icons/

Emotes

List of Github Emojis: https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md

Todo

Access static (data) files in Python: https://stackoverflow.com/a/58941536 Distributing code for end users: https://github.com/pyinstaller/pyinstaller Or create a Python package for developers, hosted on PyPi: https://packaging.python.org/en/latest/

Web apps guide https://12factor.net/

Picture tag: https://rbuchberger.github.io/jekyll_picture_tag/users/installation

Useful cheatsheet websites: https://devhints.io/ https://quickref.me

Last updated: 11 December 2022

Back to previous page