https://github.com/gbadev-org/gbadoc

Community initiated GBA Technical documentation effort
https://github.com/gbadev-org/gbadoc

Last synced: 3 months ago
JSON representation

Community initiated GBA Technical documentation effort

• Host: GitHub
• URL: https://github.com/gbadev-org/gbadoc
• Owner: gbadev-org
• License: cc0-1.0
• Created: 2021-04-08T15:17:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-24T18:49:48.000Z (8 months ago)
• Last Synced: 2024-04-14T02:22:51.596Z (7 months ago)
• Language: CSS
• Homepage: http://gbadev-org.github.io/gbadoc/
• Size: 9.37 MB
• Stars: 42
• Watchers: 3
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-CC0.txt

Awesome Lists containing this project

• awesome-starred - gbadev-org/gbadoc - Community initiated GBA Technical documentation effort (others)

README

        
# gbadoc

Community initiated GBA Technical documentation effort.

We're currently in the early stages. Join the discussions on RFCs and first content in the [Issues](https://github.com/gbdev/gbadoc/issues/) and join the `#documentation` chat channel on the [gbadev](https://discord.io/gbadev) discord.

## Building the documentation

The book is written in markdown and compiled to HTML using [mdbook][mdb-gh].

It's a tool written in Rust, but you do *not* have to have Rust installed to use it.

There are [pre-built binaries][mdb-bins] available.

[mdb-gh]: https://github.com/rust-lang/mdBook

[mdb-bins]: https://github.com/rust-lang/mdBook/releases

Basic usage:

* `mdbook serve`: builds the book and serves it at `http://localhost:3000`.

This will continue to watch the files while it's serving.

Any changes on disk will automatically trigger a new build,

and you'll see the changes just by refreshing your browser.

* `mdbook serve --open`: as above, but this also opens a browser tab to the correct URL for you.