wiki/docs/13-How-to-edit-wiki.md

94 lines
2.6 KiB
Markdown
Raw Normal View History

2023-08-16 13:27:50 -07:00
# Quick page to show how to make one in the wiki
2023-01-04 17:50:21 -08:00
2023-03-02 03:41:02 -08:00
## Best way to edit and add pages
2023-01-04 17:50:21 -08:00
2023-03-02 03:41:02 -08:00
Get this:
2023-07-03 07:11:59 -07:00
[Github Desktop](https://desktop.github.com)
2023-01-04 17:50:21 -08:00
2023-03-02 03:41:02 -08:00
Clone the wiki repo
2023-07-03 07:11:59 -07:00
[Wiki Repo](https://github.com/FOME-Tech/wiki)
2023-02-20 19:38:39 -08:00
![image](Clone.JPG)
2023-03-02 03:41:02 -08:00
Get VScode:
2023-07-03 07:11:59 -07:00
[VSCode](https://code.visualstudio.com)
2023-02-20 19:38:39 -08:00
2023-03-02 03:41:02 -08:00
Open Wiki in VScode from github desktop
![image](VScode.JPG)
2023-02-20 19:38:39 -08:00
2023-03-02 03:41:02 -08:00
Start work on the docs
![img](Docs.JPG)
2023-02-20 19:38:39 -08:00
Pages are creates with a right click and named ##-xxxx.md, they will show up as pages in the wiki.
2023-03-02 03:41:02 -08:00
Folders are creatable with a right click, they will show up like this in the wiki
![img](Folder.JPG)
2023-02-20 19:38:39 -08:00
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)
2023-02-20 19:38:39 -08:00
2023-03-02 03:41:02 -08:00
To make images work the images need to be in the same folder as the .md, they are also case sensitive so check capitals
2023-02-20 19:38:39 -08:00
2023-03-02 03:41:02 -08:00
This markdown cheat sheet will tell you everything you need to format pages
2023-02-20 19:38:39 -08:00
2023-05-01 01:54:03 -07:00
[https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
2023-02-20 19:42:26 -08:00
2023-03-02 03:41:02 -08:00
Save your work in VScode and go to github desktop
2023-02-20 19:42:26 -08:00
2023-03-02 03:41:02 -08:00
It will ask you for a title, description and to commit the changes (see bottom left of picture)
2023-02-20 19:42:26 -08:00
2023-03-02 03:41:02 -08:00
![img](Commit.JPG)
2023-02-20 19:42:26 -08:00
2023-03-02 03:41:02 -08:00
Once that is done you can push your changes and they will get automatically updated to the wiki
2023-02-20 19:42:26 -08:00
2023-02-21 18:39:50 -08:00
![img](Push.JPG)
---
- Stuff!
- More stuff!
- Stuff that looks like stuff but isn't!
2023-06-27 03:52:45 -07:00
### Subtitle 1
2023-02-21 18:39:50 -08:00
2023-06-27 03:52:45 -07:00
#### Subtitle 2
##### Subtitle 3
2023-02-21 18:39:50 -08:00
### This kind of subtitle
You can also do **this** **[link](https://fome.tech)**
### What you'll need
- [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
2023-05-01 01:54:03 -07:00
Change directory:
```bash
cd wiki
```
Install NodeJS dependencies:
```bash
npm install
```
2023-02-21 18:39:50 -08:00
Run the development server:
```bash
2023-05-01 01:54:03 -07:00
npm start
2023-02-21 18:39:50 -08:00
```
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
2023-05-01 01:54:03 -07:00
The `npm install` installs all the dependencies for your site. You'll need to run this command once when you first download the project, and again only if you `package-lock.json` file changes.
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).
2023-02-21 18:39:50 -08:00
2023-08-16 13:27:50 -07:00
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.