Skip to content

Github backup of the wiki in order to easily track changes, issues, and request reviews

Notifications You must be signed in to change notification settings

BanchanArt/wiki

Repository files navigation

BanchanArt Wiki

About

This is the readme for BanchanArt / wiki, which is the Github repository for the wiki of the BanchanArt / banchan repository.

Github Wikis automatically present all .md files, which means you may be viewing this from the repo or from the live wiki itself.

Details

The default origin of this wiki is https://github.com/BanchanArt/banchan.wiki.git. Due to this, I have set up a remote known as Github via git remote add github https://github.com/BanchanArt/wiki.git.

There a two branches:

Process

  • While on main, push to github with git push github main.
  • When ready to merge changes to the live wiki, switch to master, merge via git merge main, and run git push origin master.

Editing Notes

The Markdown used in Github Wikis differs from the Markdown used in Github Repos. Github Repos use GFM, GitHub Flavored Markdown Spec. Github Wikis use GitHub Markup but is missing some of the features listed in the markup flavors listed there. For instance, wiki files with .md ending should be compiled using CommonMarker, but the footnotes extension is disabled whereas the superscript extension works.

Quick Reference Table for Feature Support

Markdown Feature Github Wikis Github Repos Details
Notes & Warnings Known Issue Works Issue opened for this.
Footnotes Not supported, but has a known workaround Works Workaround uses superscript and links.
MediaWiki syntax links Works Does not Work Best to avoid in README.md

Quicklinks

| BanchanArt / banchan (project repo) | Live Wiki (actual wiki) | BanchanArt / wiki (repo for wiki) |

Wiki Table of Contents

The following ToC is copied from the _Sidebar.md file.

Useful Links

Additional Links

About

Github backup of the wiki in order to easily track changes, issues, and request reviews

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published