Files
Shirofune-Security a95f0f5eec docs: add Material for MkDocs documentation site (English + Japanese)
Add a documentation website under website/, built from README.md and
README-Japanese.md and laid out with top-tab topics and a left sidebar (same
style as the Hayabusa docs). Designed to be hosted free on GitHub Pages.

- Pages: Overview (About, Features, Screenshots), Getting Started, Commands
  (Command List, Command Usage), Resources (Companion Projects, Other
  Resources, Changelog, Contributing)
- Custom landing page, theme, click-to-zoom screenshots
- Changelog synced from CHANGELOG.md at build time
- 15-language switcher via mkdocs-static-i18n: English + Japanese full content;
  the other 13 localize the UI and fall back to English until translated
- .github/workflows/docs.yml builds (mkdocs --strict) + deploys to GitHub Pages

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 09:50:48 +09:00

1.3 KiB

Contributing & Support

Contributions

We would love any form of contribution. Pull requests are the best, but feature requests notifying us of bugs, etc... through issues are also very welcome.

At the least, if you like our tools and resources, then please give us a star on GitHub and show your support!

Bug Submission

  • Please submit any bugs you find here.
  • This project is currently actively maintained, and we are happy to fix any bugs reported.

License

Contributors

  • Fukusuke Takahashi (core developer)
  • Zach Mathis (project leader, tool design, testing, etc...) (@yamatosecurity)

Acknowledgements

Twitter