NRCHKB

Contribution

Updated November 14, 2022 by luwol03, Shaquu and crxporter

You want to add something to our Wiki.

How to Edit

If you want to edit a page of our wiki, nothing could be simpler, follow the steps below:

  1. Open desired page
  2. Click

    Edit this page on GitHub

    on the bottom of the page
    • You will be directed to the raw page file in our GitHub repository
  3. In GitHub editor, add or edit content after last ---
    • For content, you can use markdown (preferred) or html
  4. Create new branch for commit and create Pull Request
    • We welcome all PRs and will try to work through any suggested features & fixes.

Page Parameters

On each raw page between --- you can find page specific parameters:

Parameter Description
title Page title, used in browser tab and also displayed at the top of the page
description Description page, only displayed when you share a page
lead Mini-summary displayed below the title
date Page creation date (ISO 8601)
lastmod Page last modification date (ISO 8601), to be edited after every change. You can use this page to generate one.
weight Page order in menu
toc If page table of content On This Page should be displayed
contributors List of contributors

Markup Language used

We mainly use the markdown language to edit our pages and for more complex cases of HTML.

Image

To add an image, you must upload it to the same folder as the page you are editing and insert this code ![Edit view](edit-view.png) where you want to put your image.

If you want to add a link to another page, to a chapter (point) of a page or a link to an external site.

Within our Wiki

Structure : [Name display on the Page]({{< ref... >}} "Name of the link").

Option Description
ref "/wiki/folder" Link to a index.md Page
ref "/wiki/folder/fileName" Link to a fileName.md Page
ref "/wiki/folder/fileName#point" Link to a Point of the Page
ref . "#point" Link to a Point of the same Page

Example

  • Link to a Page:

[Host Node]({{< ref "/wiki/nodes/host-node" >}} "Host Node")

  • Link to a Point:

[Bridge Name]({{< ref "/wiki/nodes/host-node#name" >}} "Name")

External

Structure : [Name display on the Page](url).

Example

[Google](https://google.com)

Alert

If you want to add an Alert banner, insert this code:

{{< alert icon="👋" >}}Your Text{{< /alert >}}

Display:


Icon frequently used: 💡|👉|‼️

Repository directory structure

All our wiki pages are located in content/wiki folder in our repository.

..
├── wiki/
│   ├── characteristic/
│   ├── discover-more/
│   ├── examples/
│   ├── introduction/
│   ├── nodes/
│   ├── service/
│   └── _index.md
└── _index.md

Adding contributor

Once you edit or add any content you will be added to contributors list.

If you want you can create your profile page in content/contributors

  • Use this as an example.

Edit this page on GitHub

← ESP
Quick Start →