A small demo documentation site built with GitHub Pages and Jekyll.
Follow these steps to run the documentation site locally on your machine.
git clone https://github.com/MariekeVDA/MariekeVDA.github.io.git
cd MariekeVDA.github.io
GitHub Pages uses Jekyll, which requires Ruby. Install it with your system’s package manager:
macOS (Homebrew)
brew install ruby
gem install bundler
Ubuntu / Debian
sudo apt-get install ruby-full build-essential
gem install bundler
Windows Download and install Ruby from rubyinstaller.org.
Create a Gemfile (if one does not exist) with:
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
Then run:
bundle install
bundle exec jekyll serve
Open your browser and go to http://localhost:4000. The site will automatically reload when you save changes.
Just push your changes to the main branch:
git add .
git commit -m "Update documentation"
git push origin main
GitHub Pages will build and publish your site automatically within a minute or two.
| ← Getting Started | Usage → |