Colorfulstan / overwolf.github.io

The Overwolf Developers website - API Documentation, guides, etc.

Read Me

This is the repo of the Overwolf Developers website - API Documentation, guides, etc. This is intended as a quick reference and showcase.

NOTE that It will be about 2 minutes before a content change takes effect

Reference

• Search box configuration
• Markdown cheet-sheet
• Create local dev environmen
• Edit an existing page
• Add a new page
• Add a new game events status page

Search configuration

• Your search onfiguration can be configured through the DocSearch file in the Algolia GitHub repository.
  Please open a pull request if you want to leverage our Docusaurus search configuration.
• To customize the look and feel of the search box follow the DocSearch documentation.

Markdown cheet-sheet

You can find our markdown cheet-sheet here.

Create local dev environment

Basically you can do all the Docusaurus content edits directly from the GitHub web interface. But if you want to install a local version of the site, you can find all the details here.

Edit an existing page

On every page there is an "Edit" button on the right side of the page.

You can click on it, edit the page, and suggest the change as a pull request. The Overwolf team will review it, and merge it after confirmation.

Add a new page

In order to add a new page, you should:

1. Create a new file with a md (markdown) extension.
   Make sure to add it in the right section/folder (api, support, getting-started etc).

2. Add a page ID block on the top of your page. An example:

---
id: dev-console-update //unique identifier, the page URL. no spaces
title: this is the main page header
sidebar_label:  this is the menu title
---

3. Add the new page ID as a new entry in the website\sidebars.json file.
   make sure to add it in the right location. You can use these docs template as a baseline for new pages:

• API page tempalte
• Game Events page template

Add a new game events status page

In order to list a game in the game events status page, you should follow these steps:

1. Create new MD file in the "status" section. For example: \docs\status\teamfight-tactics.md.
   The template should be like the other files in that folder. Don't forget to change the GameID.

2. Add the new page to the site menu: website\sidebars.json.
   You should place it under Service\Games Events Status section.

3. Open the file website\static\js\games_metadata.js and add a record for the new file that you just created. (make sure to add the icons assets in two sizes: 60X60 and 30X30)