#43 Tech Writer buduje stronę z dokumentacją, czyli prosty przepis jak zacząć od zera
Zbudowanie strony z dokumentacją od zera może się wydawać nie lada wyzwaniem. Istnieje mnóstwo sposobów na podejście do tematu. Kiedy myślimy nad potencjalnym rozwiązaniem, do głowy przychodzą nam następujące pytania:
Czy można do tego celu użyć darmowych narzędzi? Czy istnieje coś takiego jak bezpłatny hosting? Jak pisać dokumentację bez CCMSa? Jak wygenerować PDFy bez użycia standardu DITA?
W tym odcinku staramy się stworzyć prosty (i bardzo subiektywny) przepis, który pomoże Wam zbudować nowoczesną stronę z dokumentacją w relatywnie krótkim czasie.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (creativecommons.org/license...).
Informacje dodatkowe:
- "#38 Tech Writer walczy z hakerami, czyli jak zadbać o bezpieczeństwo dokumentacji", Tech Writer koduje: techwriterkoduje.pl/blog/20...
- Static Site Generator: www.gatsbyjs.com/docs/gloss...
- Docusaurus: https://docusaurus.io/
- Algolia: www.algolia.com/
- Markdown: daringfireball.net/projects...
- Visual Studio (VS) Code: code.visualstudio.com/
- VSCodium: vscodium.com/
- Rozszerzenie Vale dla VS Code: github.com/errata-ai/vale-v...
- Git: git-scm.com/
- GitHub: github.com/
- GitHub Pages: pages.github.com/
- GitHub Actions: github.com/features/actions
- Repozytorium dla strony Tech Writer koduje: github.com/techwriterkoduje...
- TeamCity: www.jetbrains.com/teamcity/
- Jenkins: www.jenkins.io/
- Kubernetes: kubernetes.io/
- Docker: www.docker.com/
- DITA Open Toolkit (OT): www.dita-ot.org/
- Oxygen XML: www.oxygenxml.com/
- mr-pdf: www.npmjs.com/package/mr-pdf