-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Khaled Hikmat edited this page Jun 4, 2021
·
17 revisions
This platform is called goqur
. It is pronounced go cure
. It is meant to provide a set of API Endpoints to explore the different nouns and concepts in ayahs of the Quran.
This Wiki acts as a technical documentation for goqur
. Please note the following housekeeping notes about this Wiki:
- The Wiki repository is cloned and edited locally before it is pushed to the actual Wiki. Hence please do not attempt to modify the Wiki directly from the Github site
- Relative paths in Github wikis are a little strange. Provided that there is a
media
folder with images, theHome
page only uses the following format to link an image:

In all other pages, the link image format does not require the extra wiki
in the path:

Another way to do images is to dedicate a Github issue for images. Create a comment and drag & drop an image to it. Then copy and paste the full image path to the Wiki. While clever, I don't like it because I want the Wiki to be self-contained and source controlled.
- The
_Sidebar.md
contains a list of all sections, sub-sections and pages that the Wiki is composed of. It is like a launch pad for Wiki. - The
_Footer
contains the footer message for every page. - The Wiki is flat! There are no nested pages. But sections and sub-sections can be accomplished using the
_Sidebar
. - I could not find a way to override the Wiki page title. Unfortunately it shows the file name i.e.
VSCode
where I want it to show asVS Code
for example. It seems to be an expected behavior as the page name becomes the the slug in the URL. -
Mermaid is unfortunately not natively supported in Github markdown. But if you add browser extension, it displays Mermaid diagrams in
.md
files. Use Mermaid live editor to try things out:
graph TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
Copyright 2021 goqur