PEG
/
PEG-Wiki
10
1
Fork 0
Code Releases Wiki Activity

Updated Editing.md (markdown)

Abhijit Kshirsagar 2021-07-09 10:53:35 +05:30
parent cf6ff6eaa6
commit 81b38896f1
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Editing.md

@ -1,6 +1,12 @@
#### Editing #### Editing
The easiest way to edit a page on this wiki is to click on the edit button on the top of the page. New pages can be created using the "create" button. The content of a page is written in "Markdown" syntax - which means it is mostly plain text with some symbols and annotations to add formatting. For more details on syntax see the [CommonMark](https://commonmark.org/help/) syntax guide. The easiest way to edit a page on this wiki is to click on the edit button on the top of the page. New pages can be created using the "create" button. The content of a page is written in "Markdown" syntax - which means it is mostly plain text with some symbols and annotations to add formatting. For more details on syntax see the [CommonMark](https://commonmark.org/help/) syntax guide.
#### Conventions
1. Look at the souce of other pages as a guidelines on how to add new content.
2. This wiki is public, so do not add any confidential information here.
3. New pages must be named with first letter capital (e.g. "Hardware") or in Camel Case (e.g. NewStudentChecklist)
4. Adding **images** is a little tricky at the moment, and should be done using the local editing method described below. Beginners may contact [kabhijit](kabhijit) for assistance.
#### Editing Locally #### Editing Locally
If you have Ruby installed, you can clone this repo on your local machine, make edits locally, and then push changes back to Gitea. If you have Ruby installed, you can clone this repo on your local machine, make edits locally, and then push changes back to Gitea.
@ -10,3 +16,5 @@ If you have Ruby installed, you can clone this repo on your local machine, make
4. Launch Gollum in the directory where the wiki files have been cloned: ```gollum ./``` 4. Launch Gollum in the directory where the wiki files have been cloned: ```gollum ./```
5. View and edit the local files by pointing a browser to ```http://localhost:4567``` 5. View and edit the local files by pointing a browser to ```http://localhost:4567```
6. Whenever a page is saved, a commit is created automatically by gollum. Make sure to push the changes upstream after all edits are done. 6. Whenever a page is saved, a commit is created automatically by gollum. Make sure to push the changes upstream after all edits are done.
7. To add images:
1. Copy the image into the images directory. The image must be sized appropriately, since this wiki is fairly basic and does not allow dynamic scaling of images. For example, if you want the image to look small, scale the image down to