wiki_contribution

Adding an entry in the wiki

Please do not hesitate to add or edit entries in this wiki.

Adding a table of content

Table of Contents:

• Adding an entry in the wiki
  • Adding a table of content
  • For creating a new page:
  • Editing a page:
  • Adding images and pdfs and other documents:
  • Thank you for your participation!

This is obtained using vscode extension Markdown all-in-one.

For creating a new page:

• Click on the New Page button

• Edit the title (markdown file name), it NEEDS to be formatted like this: my_title_which_is_the_markdown_file_name)

• Edit the side bar (click on the pen button)

• Add a link to your new page using a link (see below). While editing the side bar you have plenty of examples for linking your page. A link is done like [[ Some text | my_title_which_is_the_markdown_file_name ]]

Editing a page:

• Just click on the edit button (the pencil)
• Click on "Save the page". (not on new page ;) )

Adding images and pdfs and other documents:

Clone the wiki locally:

git clone git@github.com:machines-in-motion/machines-in-motion.github.io.wiki.git
cp ~/Pictures/my_pictures.png machines-in-motion.github.io.wiki/pictures/
cp ~/Documents/my_doc.pdf machines-in-motion.github.io.wiki/documents/
git add --all
git commit -m "adding documents and pictures"
git push

Create the folder if necessary ;) Then link your image by using the github interface.

Thank you for your participation!