#Devdocs contribute how to#

Material for MkDocs provides several different types of admonitions and allows for the inclusion and nesting of arbitrary content. AdmonitionsĪdmonitions, also known as call-outs, are an excellent choice for including side content without significantly interrupting the document flow. Please add an example of any extension you add here. All extensions we've installed are listed below. Many require extensions, which are no issue to add. lists - could be good for tracking live course progress in jumpstart.code blocks - obviously we'll need these.The Reference Documentation offers a lot of awesome features to make the site much more approachable. The Setup Documentation is an excellent resource for site customization + configuration needs - changing colors, fonts, icons, navigation.

#Devdocs contribute how to#

What's much more important than how MkDocs internally works is how to use our theme, Material for MkDocs. answer to your question, ask for help in the developer channel of the WOO Network Discord. Sftt-auth-api.md # Should be abstracted away Llb-auth-api.md # Should be abstracted away

mkdocs -h - Print help message and exit.

mkdocs build - Build the documentation site.

mkdocs serve - Start the live-reloading docs server (you likely only need this one).

Submit your PR, and it'll be reviewed the same as any others. When you're done with your edits, simply write an update message, and select create a new branch for this commit and start a pull request.

This will take you to GitHub, where you can make whatever changes you'd like to the Markdown file which generates the page you were on. To contribute online, simply click the edit logo (the pen) in the top right corner of this page. You can make edits right on GitHub easily as well, the downside is that you cannot preview what those changes will look like in the final MkDocs generated site, so this is preferred for small tweaks rather than adding new pages entirely. When merged, your changes will automatically be deployed to our site. Include a screenshot of what your new changes look like in your PR. How to style AntD components with styled-components