Skip to content

Managing the Wiki

CristiPV edited this page Aug 29, 2021 · 2 revisions

WikiManaging the Wiki

Creating a new page

Click the green 'New Page' button.

Writing your Github Wiki page

  1. Add the title of the page.

Note: This will affect the resulting URL of your page. For instance, mine would look like so: https://github.com/scoala-online/main/wiki/Example-Page.

  1. Write the content of the page.

Github Wiki pages are generally written in Markdown. In case you are not familiar with writing in Markdown, here is a link to a cheatsheet that you can use.

I personally like to start the page by adding this line:

> [**Wiki**](https://github.com/scoala-online/main/wiki)**Example Page**

which will produce the following 'header':

  1. Save the page.

Linking your page

  1. In order to link your page nicely to the wiki, first go to the Sidebar and click on the edit icon.

  2. Find the entry of your page in the Sidebar.

Or create one yourself if it doesn't already exist.

  1. Add the link of your page in the corresponding entry.

  2. Save the changes to the Sidebar and you're done !

Getting Started

Conventions

  1. General

  1. REST API

  1. E-Learning App

Endpoints

Custom Components

Themes

Packages Used

  1. Global

  1. REST API

  1. E-Learning App

Clone this wiki locally