Skip to content

Latest commit

 

History

History

README.md

🌐HelpViewer

je moderní a rychlý nástroj pro prohlížení dokumentace Markdown a HTML přímo z archivů ZIP nebo ze složky kde bude rozbalen. Není potřeba žádná instalace, žádný server ani backend - stačí otevřít soubor index.html v prohlížeči. Licence: MIT.

Jak to funguje

  1. Zkuste si HelpViewer na svém repozitáři.
  2. Stáhněte si balíček @LTOPVERSIONN@ a rozbalte jej.
  3. Pro správné zobrazení spusťte prohlížeč bez CORS omezení. Jinak se zobrazí stránka se zprávou a budete muset ručně vybrat soubory s nápovědou a daty.
    Další možností, pokud nechcete zasahovat do CORS, je stažení lokálního HTTP serveru pro Linux (statické sestavení pod Go/musl libc) nebo Windows, založení složky www v umístění serveru, rozbalení instalace HelpViewer do této složky a spuštění serveru localhost:8080 v prohlížeči.
  4. Otevřete index.html v prohlížeči.
  5. Nastavte URL parametr ?d=X, kde X bude cesta k ZIP souboru s nápovědou nebo bude končit /, pokud má být čten obsah adresáře.
    Pokud toto neuděláte, ./hlp/Help-{vybraný jazyk prohlížeče}.zip bude určeno jako výchozí.
  6. Uvidíte uživatelskou dokumentaci přímo v HelpViewer, podobně jako teď vidíte tento web.

Použité produkty třetích stran

  • JSZip library (používáno podle MIT)
  • Marked (používáno podle MIT) (volitelné)
  • Mermaid (používáno podle MIT) (volitelné)
  • Prism (používáno podle MIT) (volitelné)
  • DOMPurify (používáno podle Apache License Version 2.0) (volitelné)