📚 Documentation
To write documentation for emote we use mdBook written in Markdown
(.md
) files. These can reference each other, and will be built into a book like HTML bundle.
See the mdBook markdown docs for details about syntax and feature support.
Helpful commands
- To build the docs:
pants package //docs:book
- To view the docs in your browser:
pants run //docs:serve
and then visit http://localhost:8000