remarkablemark.github.io
🎩 Site of @remarkablemark.
remarkablemark.org
Site of remarkablemark. Built with Jekyll and hosted on GitHub Pages.
Please support this site and join the Discord!
Prerequisites
Ruby 3.1.2:
ruby --version
If your version is behind, you can install ruby with rbenv or RVM.
rbenv
Install and set up rbenv on macOS:
brew install rbenv
rbenv init
Reload or open a new shell:
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
rbenv install
rbenv local
gem install bundler
bundler --version
Update bundler:
bundle update --bundler
Install
Clone the repository:
git clone --recursive https://github.com/remarkablemark/remarkablemark.github.io.git
cd remarkablemark.github.io
If you forgot to clone the git submodule:
git submodule update --init --recursive
To switch the git submodule remote URL from HTTPS to SSH:
cd assets
git remote set-url origin [email protected]:remarkablemark/assets.git
Install the dependencies:
bundle install
Update
Update the dependencies:
git checkout master
git pull
bundle update
Run
Development Server
bundle exec jekyll serve --livereload # --incremental --limit_posts 1
The server will be running at http://127.0.0.1:4000/:
open http://127.0.0.1:4000/
To stop the server, press CTRL-C.
Production Build
bundle exec jekyll build
The site will be generated at ./_site/.
Testing
Use HTMLProofer to validate HTML output (see post):
bundle exec jekyll build
bundle exec htmlproofer --http-status-ignore '0,301,400,401,429,999' ./_site/
Support
License
Copyright © Menglin "Mark" Xu.
