Docz - It has never been so easy to document your things!

📎 More info: https://github.com/pedronauck/docz

Transcript

1. It has never been so easy to document your things!
2. Pedro Nauck @pedronauck
4. Inspiration
9. Styleguides
12. ⚙ Need setup ⛏ Hard/impossible to customize # Complex codebase Heavy and slow Pain
13. Zero config and easy ⚡ Blazing Fast Easy to customize MDX Based Pluggable Typescript and Flow Support Solution
14. Zero-config ➡ Run without complex configurations ➡ Easy to setup and use ➡ No strict architectures
17. Blazing fast ➡ Fast build with webpack 4 ➡ Automatic code splitting ➡ Hot reload that works
19. Easy to customize ➡ Create your own style ➡ Share and create themes
21. MDX Based ➡ Markdown with components ➡ Easy to write and understand ➡ Built-ins components ➡ Remark and Rehype ecosystem
22. Is a tree representation of the abstract syntactic structure of source code written in a programming language AST
24. unified is an interface for processing text using syntax trees.
30. 1. Parse: Text => MDAST 2. Transpile: MDAST => MDXAST 3. Transform: MDX/Remark plugins applied to AST 4. Transpile: MDXAST => MDXHAST 5. Transform: Hyperscript plugins applied to AST 6. Transpile: MDXHAST => JSX Transpilation Flow
31. Pluggable ➡ Third party integration ➡ Easy to reuse and install
33. Typescript and Flow ➡ Zero config typescript and flow support
34. Live code
35. How it Works
36. YOUR DOCS THEME BUNDLER PLUGINS ENTRIES PARSE PROJECT CONFIGURATION
37. Write app files ‣ Write app files using node file system for bundle ‣ Render theme, wrappers and router Start devserver ‣ Start bundler dev server ‣ Get configuration from plugins ‣ Watch mdx and configuration file using chokidar Create data ‣ Server communication with Websockets Parse entries ‣ Get meta information using AST parsing
38. Roadmap
39. ➡ Testing documentation generation ➡ Vue, Preact and Inferno integration ➡ Static builds based on routes (SSR) ➡ Render popups on the fly (action logger) ➡ Fetch data (getInitialData) ➡ …
40. Some Numbers
48. What I’ve Learned
49. ✅ Create something that you're really going to use ✅ Explore the current pains and work upon them ✅ Work hard to build something good ✅ Be patient, your project isn’t a startup ✅ Try to find the way between an MVP and a perfect project ✅ Make a badass announcement and documentation
52. https://github.com/pedronauck/docz Give us some star
53. Questions?