Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

DevDocs

install

git clone --depth=1 https://github.com/freeCodeCamp/devdocs
cd devdocs
cp Gemfile Gemfile.bak
vim Gemfile
ruby '3.4.7'
rbenv update
rbenv install 3.4.7
rbenv shell 3.4.7
rbenv version
gem install bundler
bundle install

Arch

# Docs
bundle exec thor docs:list
bundle exec thor docs:download html
bundle exec thor docs:download --all
bundle exec thor docs:download --installed
# Docs be saved into public\docs.
# Sever
bundle exec rackup

Windows 10

scoop install curl gzip
cd <path_to>\Scoop\shims
cp gzip.exe gunzip.exe
cp gzip.shim gunzip.shim

Deploy with Docker compose

1

mkdir devdocs
cd devdocs
vim docker-compose.yml
services:
  devdocs:
    image: ghcr.io/freecodecamp/devdocs:latest
    container_name: devdocs
    ports:
      - "9292:9292"
    restart: always
sudo docker compose up -d

Troubleshoot


  1. Using Docker (Recommended)