#25 Tech Writer koduje w dokumentacji, czyli Markdown w wersji rozszerzonej

26:59
 
Udostępnij
 

Manage episode 282832477 series 2508014
Stworzone przez Doc Developer, odkryte przez Player FM i naszą społeczność - prawa autorskie są własnością wydawcy, a nie Player FM, a dzwięk jest przesyłany bezpośrednio z ich serwerów. Naciśnij przycisk Subskrybuj, aby śledzić aktualizacje Player FM, lub wklej adres URL kanału do innych aplikacji podcastowych.

Markdown to prosty i lekki język znaczników, który w ostatnich latach zyskał sporą popularność, szczególnie w świecie dokumentacji dla programistów. Pozwala nam on łatwo i szybko stworzyć tekst, a następnie opublikować go jako HTML. Z biegiem czasu pojawiły się różne odmiany i rozszerzenia Markdowna, pozwalające wycisnąć z niego jeszcze więcej. Jednym z nich jest MDX, który pozwala na używanie bezpośrednio w tekście elementów JSX. Takie rozwiązanie otwiera przed nami nowe możliwości, jak na przykład opcję umieszczenia w dokumentacji interaktywnej próbki kodu. Dzięki temu możemy przesunąć naszą dokumentację na wyższy poziom. Rozmawiamy o tym czym jest MDX, jakie daje nam możliwości i w jakich sytuacjach może nam się przydać.

Muzyka w intro oraz dźwięki 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.

Informacje dodatkowe:

Markdown: https://daringfireball.net/projects/markdown/syntax

MDX: https://mdxjs.com/

Wprowadzenie do JSX: https://pl.reactjs.org/docs/introducing-jsx.html

React: https://pl.reactjs.org/

"What is a Static Site Generator? And 3 ways to find the best one": https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/

Docusaurus v2: https://v2.docusaurus.io/

Gatsby: https://www.gatsbyjs.com/

Next.js: https://nextjs.org/

Create React app: https://github.com/facebook/create-react-app

Carbon React: https://react.carbondesignsystem.com/

React Bootstrap: https://react-bootstrap.github.io/

Swagger UI: https://swagger.io/tools/swagger-ui/

webpack: https://webpack.js.org/

27 odcinków