Skip to content

Moving forward

Upon completing this tutorial you should know the basics on how to edit and submit your team wiki.
Below we offer some suggestions on how to take a step further and be more effective in the process.

MkDocs and Material for MkDocs

We presented some of the most important features for customizing your wiki contents, but you may wish to know that these static site generators allow many more customizations, like changing theme colors and adding emojis.

For more information on the underlying mechanism of MkDocs, please check their documentation site.

For information on customizing the theme, please see Material for MkDocs.

Useful features in Material for MkDocs

In the mock wiki for this tutorial, we have a page demonstrating 3 useful features enabled by default:

  • Mathematical equations input by LaTeX
  • Sortable Tables
  • Markdown footnotes for citations

Be sure to check the Markdown file behind if your team use Material for MkDocs for your wiki.

Git and GitHub

Throughout this tutorial we used GitHub Desktop for version control illustration. GitHub Desktop provides an intuitive graphic user interface (GUI) which is great for beginners. You can find a lot of help from the documentation of GitHub Desktop and our tutorial is to some extent based on it.

As you move forward, you may find the command line interface (CLI) version more powerful since it permits automation of tasks.

Need help?

Post a message on iDEC 2021's Slack channel, or, email us at support@idechq.org with a subject titled

[Team Wiki] {your issue}

and we will get back to you as soon as we can.