Static site documentation

[kissgyorgy]

• [x] Set up Material for MkDocs https://squidfunk.github.io/mkdocs-material/
• [x] Pages:
  • [x] Home/About
  • [x] User Guide @kissgyorgy
  • [x] Installation
  • [x] Supported Formats
  • [x] Extractors
  • [x] Development guide @kissgyorgy
  • [x] Glossary @kissgyorgy
  • [x] Support
• [ ] Eye-candy architecture picture, put it under "How does it work?" in About page.
• [x] Demo with asciinema and https://github.com/marionebl/svg-term-cli
• [x] Move wiki pages to documentation @kissgyorgy
• [ ] Branding and theme:
  • [ ] set up social cards: https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
  • [x] Company branding style @martonilles
• [x] Deployment:
  • [x] Self-host asciinema demo, sometimes it's loads very slowly. or try: https://nbedos.github.io/termtosvg/
  • [x] Publish generated pages with GitHub CI to GitHub pages
  • [x] register domain in DNS @martonilles
  • [x] set DNS records to registered domain GitHub documentation about domain settings
• [x] delete most of README and point to documentation
• [ ] Fix Source install section, it doesn't work if followed step-by-step: https://github.com/onekey-sec/unblob/issues/418

---

• [ ] Pages:
  • [ ] API reference
• [ ] Set up https://github.com/mkdocstrings/mkdocstrings for API generation
• [ ] Make the public API documented
• [ ] Github issue template instead of "Reporting a Bug" page

[kissgyorgy]

svg-term-cli generates a huge file, which eats my browsers memory and crashes the page 😄 so I just include the embedded asciinema recording:

[vlaci]

I used https://nbedos.github.io/termtosvg/ in the past but it is unmaintained. Do we need debug output anyway?

[martonilles]

API reference should go in v2

[kissgyorgy]

Do we need debug output anyway?

I first tried without debug output, but I wanted to keep it real-time, as it takes 15 seconds total, but without debug, nothing happens for a long time. This way, while the reader gets through the first couple of lines, something else with happen, so I found it the best balance between timing, readability and wow effect. Also the first debug messages describe better what is happening for a visitor who never seen the tool.

[kissgyorgy]

I'm ready with the content. #410