Welcome to Jekyll!
Posts
This post is in the _posts
directory.
Edit and rebuild the side to see changes with bundle exec jekyll serve
which launches a web server and auto-regenerates your site when a file is updated.
New Posts
To add new posts, add a file in the _posts
directory that follows the convention YYYY-MM-DD-name-of-post.md
and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Code Snippets
function f(): string {
return "hello";
}
console.log(f())
Links
Info on how to get the most out of Jekyll on Jekyll docs.
File all bugs/feature requests at Jekyll’s GitHub repo.
Ask questions on Jekyll Talk.
This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
You can find the source code for Minima at GitHub: jekyll / minima
You can find the source code for Jekyll at GitHub: jekyll / jekyll
GitHub Setups
GitHub Software Installed on docs runner
Local Testing
Check Ubuntu version
lsb_release -a
On Windows
Using WSL2 with ubuntu 20 follow setup.
Setup
Packages have dependencies on multiple compilers:
https://jekyllrb.com/docs/installation/
sudo apt-get install gcc -y
sudo apt install g++ -y
sudo apt-get update --fix-missing
sudo apt install make
Once those compilers are installed:
sudo apt-get install ruby-full
sudo gem install jekyll bundler
Launch The Server
With the following installed, launch the server
cd docs
bundle install
bundle exec jekyll serve
Notes for Ubuntu 22
Before doing the setup
Ubuntu 22 comes with ruby 3 which is not compatible with the github-pages. Use ruby 2 with rvm.
-
Install RVM
sudo apt install gnupg2
gpg --keyserver keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io | bash -s stable
After installing rvm restart WSL
-
Install older ruby version
rvm pkg install openssl
- Enter the password.
rvm install "ruby-2.7.6" --with-openssl-dir=$HOME/.rvm/usr
-
Check Installed Ruby Versions
rvm list known
-
Use Installed ruby versions
rvm use ruby-2.7.6
-
Check ruby version
ruby --version
-
Follow setup steps