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

Update 'Editing'

Abhijit Kshirsagar Kshirsagar 2021-07-14 15:00:25 +05:30
parent 5c929a75b2
commit 0e7fba801f
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Editing.md

@ -1,22 +1,23 @@
#### 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.
#### 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
If you have Ruby installed, you can clone this repo on your local machine, make edits locally, and then push changes back to Gitea.
1. To find the clone URL for the wiki, look for the clone URL on the top of the Gitea Page. Note that the URL should end in ".wiki.git"
2. Clone the repo locally
3. Install Gollum: ```gem install 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```
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
2. The image must be sized appropriately.This wiki is fairly basic and does not allow dynamic scaling of images. For example, if you want the image to look small, you should re-size the image down to about 200px wide. For example, the logo on [the homepage of the wiki](Home) is 200px wide.
#### 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.
#### 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
If you have Ruby installed, you can clone this repo on your local machine, make edits locally, and then push changes back to Gitea.
1. To find the clone URL for the wiki, look for the clone URL on the top of the Gitea Page. Note that the URL should end in ".wiki.git"
2. Clone the repo locally
3. Install Gollum: ```gem install gollum```
1. If you get errors during this installation it is probabaly due to ```cmake``` missing on your system. Run ```sudo apt-get install cmake```
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```
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
2. The image must be sized appropriately.This wiki is fairly basic and does not allow dynamic scaling of images. For example, if you want the image to look small, you should re-size the image down to about 200px wide. For example, the logo on [the homepage of the wiki](Home) is 200px wide.
3. Include it using the following syntax: ``![Text description](images/filename.png)``