wiki/docs/First-Page-Tutorial.md

94 lines
2.5 KiB
Markdown
Raw Normal View History

2023-02-21 18:39:50 -08:00
---
sidebar_position: 1
---
2023-01-04 17:50:21 -08:00
# Quick page to show how to make one in the wiki.
2023-02-20 19:38:39 -08:00
## Best way to edit and add pages
2023-01-04 17:50:21 -08:00
2023-02-20 19:38:39 -08:00
Get this:
https://github.com/FOME-Tech/FOME-Baseline/issues/labels
2023-01-04 17:50:21 -08:00
2023-02-20 19:38:39 -08:00
Clone the wiki repo
https://github.com/FOME-Tech/wiki
![image](Clone.JPG)
Get VScode:
https://code.visualstudio.com
Open Wiki in VScode from github desktop
2023-02-20 19:42:26 -08:00
![image](VScode.JPG)
2023-02-20 19:38:39 -08:00
Start work on the docs
2023-02-20 19:42:26 -08:00
![img](Docs.JPG)
2023-02-20 19:38:39 -08:00
Folders are creatable with a right click, they will show up like this in the wiki
2023-02-20 19:42:26 -08:00
![img](Folder.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-02-20 19:42:26 -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
This markdown cheat sheet will tell you everything you need to format pages
2023-02-20 19:42:26 -08:00
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
2023-02-21 18:39:50 -08:00
![img](Push.JPG)
---
- Stuff!
- More stuff!
- Stuff that looks like stuff but isn't!
##### Subtitle
#### No not that kind of subtitle
### 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.
## Generate a new site
Generate a new Docusaurus site using the **classic template**.
The classic template will automatically be added to your project after you run the command:
```bash
npm init docusaurus@latest my-website classic
```
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
The command also installs all necessary dependencies you need to run Docusaurus.
## Start your site
Run the development server:
```bash
cd my-website
npm run start
```
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.
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.