This documentation is currently hosted at bitcoincore.academy however this location may be subject to change in the future.
The easiest way to serve the site locally is using Docker:
docker compose up devThis will: - Build the development environment - Install all dependencies (Ruby gems and Node.js packages) - Start a Jekyll development server on port 4000 - Mount the current directory for live reloading - Use development environment settings
The site will be available at http://localhost:4000
The project includes several useful Makefile targets for development and deployment:
-
make docker-dev- Start development server using Docker Compose -
make docker-shell- Open an interactive shell in the Docker container -
make docker-clean- Clean up Docker containers and system resources
-
make build- Build the Jekyll site into_sitedirectory -
make preview- Build and serve the site locally with live reload -
make clean- Clean up generated files
-
make test-before-build- Run pre-build tests (Markdown linting) -
make test-after-build- Run post-build tests (link checking, duplicate anchors) -
make all- Complete build and test pipeline
-
Local Development: Use
docker compose up devormake docker-devto start the development server -
Shell Access: Use
make docker-shellto access the container for debugging or manual commands -
Testing: Run
make allbefore submitting changes to ensure everything builds and passes tests -
Cleanup: Use
make docker-cleanto clean up containers and free disk space
The project uses: - Jekyll for static site generation - Asciidoctor for processing AsciiDoc files - Mermaid CLI for diagram generation - HTMLProofer for link checking - Markdownlint for Markdown validation
All dependencies are managed through the Docker container, so you don’t need to install anything locally except Docker.
See asciidoc_workflow.adoc for detailed contributing guidelines and AsciiDoc formatting instructions.