jayden11 / algoquant.github.io

algoquant's website on GitHub

This is the repository for algoquant's Home Page on GitHub

The website is hosted on GitHub Pages at https://algoquant.github.io/

Website design

The website was created using Jekyll, and its theme was adapted from the Jekyll-Architect theme by Pietro Menna, and the Beautiful-Jekyll theme by Dean Attali.

Jekyll is a website generator which compiles markdown files into HTML. You can find more information about Jekyll here: Jekyll web page

A Jekyll theme is a set of HTML and CSS files that determine the appearance of a website, like the fonts, colors, shading, and page layouts. A Jekyll theme can be adapted to create websites with the same appearance as the theme has. Here you can find more: Jekyll themes

Website structure

The website code is written in markdown, HTML, CSS, YAML, and liquid. The website consists of directories containing several different types of files:

• the website parameters and settings are in the _config.yml file (written in YAML) in the root directory,
• the parameters for the Jekyll processor are in the Gemfile file in the root directory,
• the website contents are written in markdown and R Markdown files collected in the _pages and _posts directories,
• the page layouts are written in HTML files collected in the _layouts and _includes directories,
• the page designs are in CSS files collected in the stylesheets directory,
  The markdown and HTML files also contain liquid code for referencing website parameters and settings.

Website download

You can download the website files from here:
Download theme.zip file
Download theme.tar.gz file

Once you have downloaded the archive, you can unzip the website files into a directory on your computer. But be aware that my website isn't a static website theme, but rather it's a complete website, and its contents change over time.

You can then replace the contents of the markdown files in the _pages and _posts directories with your own. You must also modify the website parameters in the _config.yml file. Do the following:

• replace the contents of markdown and R Markdown files,
• modify the website parameters in the _config.yml file,

Jekyll installation

You can install the website on your computer, but you must first install Ruby, Jekyll, and bundler. I installed the website under Windows (which I hate, but have been forced to use it at work, and have continued to use it due to inertia). If you're also using Windows, then you can first install chocolatey, which is a package manager for Windows).

You can then install Ruby, Jekyll, and bundler with the following commands in a command window, each time reopening the command window, and installing one by one:
choco install ruby -y
gem install jekyll
gem install bundler

You can find more detailed instructions here:
install Ruby
install Jekyll
install Ruby and Jekyll on Windows

You may also need to install the Ruby development kit for compiling Ruby gems (packages that provide extra functionality):
install Ruby devkit installation
install Ruby devkit installer

Website installation

Jekyll is a website generator which compiles markdown files containing the website content, together with HTML and CSS theme files, into HTML files ready to be served on the website.

After you've installed Ruby, Jekyll, and bundler, you can then install the website on your computer, by opening a command window, navigating to the website directory, and executing the following commands:
bundle install
bundle exec jekyll serve

If you later add gems in the _config.yml file, then you may need to execute the commands:
bundle update
bundle exec jekyll serve

The command jekyll serve builds the static website files in the _site sub-directory, and starts a web server running locally on your computer. You can view the website in your browser under the address:
http://localhost:4000/

The command bundle exec jekyll serve runs the Ruby bundler which builds the website using all the gems specified in the Gemfile, and manages all the software dependencies.
The command bundle exec jekyll serve --trace --verbose provides extra information about the build process.

Once you're satisfied with the website build on your computer, you can then upload it to GitHub by following these instructions: GitHub instructions

Adding Disqus comments, Sharing on LinkedIn

https://harringa.com/posts/2015/12/19/adding-disqus-to-jekyll-site/
http://sgeos.github.io/jekyll/disqus/2016/02/14/adding-disqus-to-a-jekyll-blog.html
https://developer.linkedin.com/docs/share-on-linkedin
https://superdevresources.com/share-buttons-jekyll/

Additional references

Here are some blogs and tutorials about building static websites on GitHub using Jekyll:

• Very good and detailed tutorial
• Simple tutorial

http://pixelcog.com/blog/2013/jekyll-from-scratch-introduction/
http://pixelcog.com/blog/2013/jekyll-from-scratch-core-architecture/
http://pixelcog.com/blog/2013/jekyll-from-scratch-extending-jekyll/

• Jekyll home
• Jekyll tutorials
• Jekyll file structure
• Jekyll Now for easy building of websites (I haven't used it)
• Install Jekyll on Windows
• Jekyll themes

GitHub Pages help:
https://pages.github.com/ https://help.github.com/categories/github-pages-basics/
https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/
https://help.github.com/articles/creating-pages-with-the-automatic-generator/
https://help.github.com/articles/configuring-jekyll/
https://help.github.com/articles/user-organization-and-project-pages/
https://help.github.com/categories/customizing-github-pages/
https://blog.r3bl.me/en/jekyll-blogging-like-a-pro/

Nice Jekyll themes

• repository of Jekyll themes
• simple and customizable Jekyll theme
• simple Jekyll theme with menu and sidebar
• fancy Jekyll theme with menu and sidebar
• Jekyll theme with sidebar <>

Command for creating template Jekyll directory (uses very simple page layout and theme):
bundle exec jekyll new C:/Develop/web/site_template --force

More references about building websites on GitHub using Jekyll

https://ines.io/blog/the-ultimate-guide-static-websites-jekyll
https://davidwalsh.name/introduction-static-site-generators
https://mademistakes.com/articles/using-jekyll-2016/

Below are more references about building websites

Building websites using R Markdown and knitr

I use R for all my work, so in the future I may also try building my websites using R Markdown and knitr. Here are some references about building websites using R Markdown and knitr:

• R Markdown websites
• Building websites using R Markdown and knitr

https://github.com/yihui/knitr-jekyll
https://github.com/yihui/servr
https://github.com/homerhanumat/homerhanumat.github.io
http://statistics.rainandrhino.org/knitr-hyde/
http://statistics.rainandrhino.org/knitr-lanyon/
http://statistics.rainandrhino.org/2015/12/15/jekyll-r-blogger-knitr-hyde.html
http://www.sciviews.org/blog/The-SciViews-Jekyll-Template/
https://help.github.com/articles/using-a-custom-domain-with-github-pages/

Hacking htmlwidgets into website using rmarkdown{:target="_blank"}
Hacking htmlwidgets into website using Jekyll{:target="_blank"}