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

Published: Jan. 21, 2021, 2:10 p.m.

b'

Markdown to prosty i lekki j\\u0119zyk znacznik\\xf3w, kt\\xf3ry w ostatnich latach zyska\\u0142 spor\\u0105 popularno\\u015b\\u0107, szczeg\\xf3lnie w \\u015bwiecie dokumentacji dla programist\\xf3w. Pozwala nam on \\u0142atwo i szybko stworzy\\u0107 tekst, a nast\\u0119pnie opublikowa\\u0107 go jako HTML. Z biegiem czasu pojawi\\u0142y si\\u0119 r\\xf3\\u017cne odmiany i rozszerzenia Markdowna, pozwalaj\\u0105ce wycisn\\u0105\\u0107 z niego jeszcze wi\\u0119cej. Jednym z nich jest MDX, kt\\xf3ry pozwala na u\\u017cywanie bezpo\\u015brednio w tek\\u015bcie element\\xf3w JSX. Takie rozwi\\u0105zanie otwiera przed nami nowe mo\\u017cliwo\\u015bci, jak na przyk\\u0142ad opcj\\u0119 umieszczenia w dokumentacji interaktywnej pr\\xf3bki kodu. Dzi\\u0119ki temu mo\\u017cemy przesun\\u0105\\u0107 nasz\\u0105 dokumentacj\\u0119 na wy\\u017cszy poziom. Rozmawiamy o tym czym jest MDX, jakie daje nam mo\\u017cliwo\\u015bci i w jakich sytuacjach mo\\u017ce nam si\\u0119 przyda\\u0107.

\\n

Muzyka w intro oraz d\\u017awi\\u0119ki pochodz\\u0105 z kolekcji "107 Free Retro Game Sounds" dost\\u0119pnej na stronie https://dominik-braun.net, udost\\u0119pnianej na podstawie licencji Creative Commons license CC BY 4.0.

\\n

Informacje dodatkowe:

\\n

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

\\n

MDX: https://mdxjs.com/ 

\\n

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

\\n

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

\\n

"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/

\\n

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

\\n

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

\\n

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

\\n

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

\\n

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

\\n

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

\\n

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

\\n

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

'