Skip to content

Wiki Editing

Jump to bottom
Vladimir Alexiev edited this page May 5, 2025 · 2 revisions

This project has a wiki that we use extensively.

TOC in Sidebar

There is a sidebar with all pages and a collapsible menu that shows the outline (TOC) of each page:

image

TOC in Home Page

There is also a home page where we can add some extra structure, and extra pages that we want to create some day (shown as "red links": click on the link to start editing the new page):

Editing

Any project member can edit pages on the web (eg here is Home page edit).

Programmers can also checkout the wiki, just like they can checkout the main project, and edit on their local computer:

git clone git@github.com:statnett/Talk2PowerSystem.git
git clone git@github.com:statnett/Talk2PowerSystem.wiki.git

Please note:

  • A link/title Some Page generates a file Some-Page.md (i.e. dashes are added to the filename).
  • The home page uses MediaWiki syntax while other pages use Markdown.
  • The syntax can be switched per page, and AsciiDoc is also available. However, switching the syntax does not automatically convert the page to the new syntax
  • For web editing: you can paste an image into the editor. It's saved to https://github.com/user-attachments/assets/ (just like the images in this page), and added to the page
  • If you checkout: we prefer images to be in folder img/, especially if they'd be reused between pages
  • For both wiki and READMEs, we use Semantic Line Breaks, which helps to express thoughts more clearly and to diff/merge versions. That means to put each "unit of thought" (important clause) on a separate line. See the source of this page for examples.

Clone this wiki locally