How To Make Wikis
Dat image link doe! Note the folder prefix.
This is an anchor link example
Bottom of page
This page essentially is a style guide as well, but really all one needs to do is clone the wiki space, for this wiki its: https://github.com/NASA-JSC-Robotics/valkyrie.wiki.git
Make sure when you're adding pages you follow the github style. All pages must be capitalized. Some special pages will have an underscore infront of them, these are sitewide additions to the wiki pages and will show up on every page.
Examples:
New-Page.md Home.md _Footer.md
Wikis on github use pure markdown for formatting.
Note: In order to 'return' you have to add two blank spaces on the end of a line.
If you forget to add the spaces
you get one run-on sentence.
Be sure to look at the following links for a solid example for formatting.
Also make sure to look at how you can do username @ mentions, SHA references, and github issue references.
Everyone does markdown a bit different, make sure you use the official github markdown guides.
- Github Markdown Guide
- Live Editor
- Github wiki showcase. Great examples
- Link to great basic github wiki
These examples really only make sense if you clone this wiki and look at the actual markdown files.
#Titles, yaazzz such title, so wow, very impress
The following is a great code fencing example 👍
print "hello world"You can also inline code examples in a sentence.
- Item number one, Robots
- Item number two, ??????
- Item number three, profit?
- I
- Am
- A
- Bullet List
- I am
- another bullet list
- Make a task list 💥
- Figure out life 🐫
- Get a life? ✨
Coffee. The finest organic suspension ever devised... I beat the Borg with it.
- Captain Janeway
Header | Other Header | other other header :--------:|--------:|:--------|-------- centered | right aligned | left aligned | Regular Cell Stuff 1b | Cell Stuff 2b | stuff | align