mirror of
https://github.com/gbdev/pandocs.git
synced 2026-03-27 07:26:25 +00:00
The single, most comprehensive Game Boy technical reference.
https://gbdev.io/pandocs/
- Markdown 84.6%
- Rust 6.4%
- JavaScript 5.5%
- Python 1.7%
- CSS 1.5%
- Other 0.3%
405801321c* Remove multilingual from book.toml This field was removed in mdbook 0.5.0-alpha.1 because it was never actually in use: https://github.com/rust-lang/mdBook/pull/2775 * Update preprocessor and renderer to use their appropriate cargo crates As of mdbook 0.5, preprocessor functionality and renderer functionality have been broken up into separate crates. This commit refactors those features to use the appropriate crates. * CI: Update Github workflows to account for the mdBook upgrade mdBook was still referring to 0.4.x versions in the github workflow, and mdbook-linkcheck has not been updated to support 0.5. This commit switches the repo to using "mdbook-linkcheck2", which is a fork that's been properly updated. mdbook-linkcheck2 does not have any releases associated with the repo, which meant I had to switch installation methods. As such, I moved towards a (hopefully) straightforward `cargo install` approach. * Dockerfile: lock to 0.5.2 * docs: update instructions for mdbook 0.5.2 * linkcheck: stop checking external links --------- Co-authored-by: Antonio Vivace <avivace4@gmail.com> |
||
|---|---|---|
| .github | ||
| custom | ||
| historical | ||
| preproc | ||
| renderer | ||
| src | ||
| theme | ||
| .gitattributes | ||
| .gitignore | ||
| book.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| DEPLOY.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| requirements.txt | ||
Pan Docs
"Pan Docs" is a document started in early 1995, considered the single most comprehensive technical reference to Game Boy available to the public.
This git repository hosts a renewed version of it, mantained in the Markdown format and enjoying renewed community attention.
Go to gbdev.io/pandocs to read the document.
Contributing
Everyone is welcome to contribute opening issues, expressing feedback, adding and improving content or share new findings. Please, check the contributing guidelines for a complete view on how to contribute to this project or read the deploy instructions to run a local copy of Pan Docs.
License
Pan Docs is released into the public domain.