Skip to content

Commit

Permalink
Update 13-How-to-edit-wiki.md (#141)
Browse files Browse the repository at this point in the history
as promised in #102 (comment)
I'll work to improve this step by step
  • Loading branch information
mi-hol authored Sep 2, 2023
1 parent 1470a61 commit f96cf5d
Showing 1 changed file with 46 additions and 30 deletions.
76 changes: 46 additions & 30 deletions docs/13-How-to-edit-wiki.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Quick page to show how to make one in the wiki
# How to add, change and test a page in the wiki

## Best way to edit and add pages
## Prerequisites

- A free login in GitHub

## Simplest approach to make a small change

- go to end of page and click on "Edit this page" link

## Best way to edit or add a larger number of pages

Get this:
[Github Desktop](https://desktop.github.com)
Expand All @@ -16,7 +24,7 @@ Get VScode:
Open Wiki in VScode from github desktop
![image](VScode.JPG)

Start work on the docs
Start to edit the docs
![img](Docs.JPG)

Pages are creates with a right click and named ##-xxxx.md, they will show up as pages in the wiki.
Expand All @@ -27,44 +35,22 @@ Folders are creatable with a right click, they will show up like this in the wik
To control ordering of topics in sidebar navigation the so called "numbered prefix" concept is used.
This concept is further explained in [linked section of Docusaurus user manual](https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes)

To make images work the images need to be in the same folder as the .md, they are also case sensitive so check capitals
To make images work the images need to be in the same folder as the .md, image names are also case sensitive so check capitals.

This markdown cheat sheet will tell you everything you need to format pages

[https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

Save your work in VScode and go to github desktop

It will ask you for a title, description and to commit the changes (see bottom left of picture)

![img](Commit.JPG)

Once that is done you can push your changes and they will get automatically updated to the wiki

![img](Push.JPG)

---

- Stuff!
- More stuff!
- Stuff that looks like stuff but isn't!

### Subtitle 1

#### Subtitle 2

##### Subtitle 3

### This kind of subtitle
Save your work and proceed to testing of change.

You can also do **this** **[link](https://fome.tech)**
## How to test your changes

### What you'll need
### Prerequisites for local test

- [Node.js](https://nodejs.org/en/download/) version 16.14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

## Start your site
### run Docusaurus locally

Change directory:

Expand All @@ -91,3 +77,33 @@ The `npm install` installs all the dependencies for your site. You'll need to ru
The `npm start` command builds your website locally and serves it through a development server, ready for you to view at [http://localhost:3000](http://localhost:3000).

Open `docs/13-How-to-edit-wiki.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

### How to publish your change to wiki

in VScode and go to github desktop

It will ask you for a title, description and to commit the changes (see bottom left of picture)

![img](Commit.JPG)

Once that is done you can push your changes and they will get automatically updated to the wiki

![img](Push.JPG)

---

## How to structure

- Stuff!
- More stuff!
- Stuff that looks like stuff but isn't!

### Subtitle 1

#### Subtitle 2

##### Subtitle 3

### This kind of subtitle

You can also use like **this** **[link](https://fome.tech)**

0 comments on commit f96cf5d

Please sign in to comment.