#43 Tech Writer buduje stronę z dokumentacją, czyli prosty przepis jak zacząć od zera

Tech Writer Koduje

Treść dostarczona przez Michał Skowron i Paweł Kowaluk, Michał Skowron, and Paweł Kowaluk. Cała zawartość podcastów, w tym odcinki, grafika i opisy podcastów, jest przesyłana i udostępniana bezpośrednio przez Michał Skowron i Paweł Kowaluk, Michał Skowron, and Paweł Kowaluk lub jego partnera na platformie podcastów. Jeśli uważasz, że ktoś wykorzystuje Twoje dzieło chronione prawem autorskim bez Twojej zgody, możesz postępować zgodnie z procedurą opisaną tutaj https://pl.player.fm/legal.

3y ago 35:33

MP3•Źródło odcinka

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 https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Informacje dodatkowe:

"#38 Tech Writer walczy z hakerami, czyli jak zadbać o bezpieczeństwo dokumentacji", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/01/10/tech-writer-walczy-z-hakerami
Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
Docusaurus: https://docusaurus.io/
Algolia: https://www.algolia.com/
Markdown: https://daringfireball.net/projects/markdown/syntax
Visual Studio (VS) Code: https://code.visualstudio.com/
VSCodium: https://vscodium.com/
Rozszerzenie Vale dla VS Code: https://github.com/errata-ai/vale-vscode
Git: https://git-scm.com/
GitHub: https://github.com/
GitHub Pages: https://pages.github.com/
GitHub Actions: https://github.com/features/actions
Repozytorium dla strony Tech Writer koduje: https://github.com/techwriterkoduje/site-source
TeamCity: https://www.jetbrains.com/teamcity/
Jenkins: https://www.jenkins.io/
Kubernetes: https://kubernetes.io/
Docker: https://www.docker.com/
DITA Open Toolkit (OT): https://www.dita-ot.org/
Oxygen XML: https://www.oxygenxml.com/
mr-pdf: https://www.npmjs.com/package/mr-pdf

78 odcinków

#Doc Developer #Technologie