Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

Latest commit

 

History

History
38 lines (25 loc) · 2.21 KB

README.md

File metadata and controls

38 lines (25 loc) · 2.21 KB
Raw

Chatoverflow wiki

This repository contains the files for the chatoverflow wiki. For more information about the chat overflow project, please visit codeoverflow.org.

Contributing

You have an idea how the wiki could be improved or just found some typos/spelling mistakes?

Everybody can easily contribute to the wiki:

  1. Navigate the the right file in the wiki
  2. Click on the ✎ icon in the upper right corner
  3. Edit the page
  4. Enter a message that describes your change and click on Propose file change.
  5. Click on Compare & Pull Request to suggest the change. Add a fitting title and submit the PR.
  6. We'll review the change and merge it if it fits.

If you are experienced with git you can of course also fork this repo, do commits and create a pull request.

Thanks a lot to everybody who is willing to improve the wiki! You are awesome!

Custom markdown

The wiki uses multiple extensions and plugins that introduce custom markdown.

Here is a list of the most important ones including links to the documentation so you can figure out how to use them:

  • Admonition - Adds block-styled side content to the documentation, for example blocks containing notes, examples, hints or warnings.

  • Details from PyMdown Extensions - Adds blocks just like the ones from Admonition but collapsible.

  • SuperFences from PyMdown Extensions - Allows nesting of code blocks. Also allows to highlight lines in code blocks and to create code blocks with multiple tabs for multiple languages.

If you know other extensions/plugins that could improve the wiki let us know so we can add them or add them to the mkdocs.yml and the requirements.txt yourself and create a pull request.

Copyright Notices

The following 3rd party software is included in this repo: