Skip to content

Update readme with few additional markup concept #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Certsoftt wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update readme with few additional markup concept #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d1c119
Update Readme with few useful markdown concepts
Certsoftt Mar 25, 2025
6332331
Update README.md
Certsoftt Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 85 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,13 @@ in lowercase letters, conveniently placing README before the rest of the content
* 3.6. Italics
* 3.7. Fatty
* 3.8. Strikethrough
* 3.9. Text Comparism and Suggestion
4. [Insert tables](#Insert-tables)
* 4.1. Aligning Table Content
5. [Lists](#Lists)
* 5.1. Marked
* 5.2. Numbered
* 5.3. CheckList
6. [Links](#Links)
* 6.1. Text hyperlink
* 6.2. Image link
Expand Down Expand Up @@ -153,7 +156,15 @@ you can highlight individual words in the text.
``
Life is what happens to you while you are making plans.
John Lennon
``
``<br/>
Sometimes when making emphasis, we use quote to highlight texts we want to make emphasis. We can do this using the greater than symbol `>` before the text we want to emphasize.

```
> emphasized text
```

We can select text by using single backtick wrap round the text like: `emphasized text`


``Logic`` can take you from point A to point B, and ``imagination`` can take you anywhere. (Albert Einstein)

Expand Down Expand Up @@ -218,6 +229,39 @@ Place text between two double '~' characters and it will turn into
~~Strikethrough TEXT~~
```

[Back to Table of Contents](#Table-of-Contents)
____
### 3.9. Text Comparism and Suggestion
Same as implementing code fragment using three(3) backticks and specifying the programming language as describe in [3.4. Text Selection](#34-text-selection).

For Text comparism you use a `diff` instead of a programming language.

Let say you have a suggestion to make in comparing your observation on a specific change you want to make in a code. For instance, we want to add a change to a line of code while taking out what was there initially. Before, the line of code that we want to remove:

```js
const data = []
```
After, our suggestion on what we want to have the code changed to:

```js
const data = {}
```

We can simply write:

My Suggestion

3 backticks followed by `diff`
- const data = []
+ const data = {}
end with 3 backticks

and this should produce:
```diff
- const data = []
+ const data = {}
```
____
[Back to Table of Contents](#Table-of-Contents)
____
## Insert tables
Expand All @@ -234,6 +278,38 @@ simple table
|Profession| python-developer|
|Article| About markup in the README|

### 4.1. Aligning Table Content

We can left align, right align, and center-align table of content using column `:` at various positions respectively.
- Left aligning: place column symbol to the left as shown below. The `Author` Column is left-align
- Right aligning: place column symbol to the right as shown below. `Andrey Marinchenko` is right-align

```
|Author|Andrey Marinchenko|
|:---|---:|
|Profession| python-developer|
|Article| About markup in the README|
```

|Author|Andrey Marinchenko|
|:---|---:|
|Profession| python-developer|
|Article| About markup in the README|

- center aligning: place column symbol on both sides as shown below. Both `Author` column and `Andrey Marinchenko` is center-align.

```
|Author|Andrey Marinchenko|
|:---:|:---:|
|Profession| python-developer|
|Article| About markup in the README|
```

|Author|Andrey Marinchenko|
|:---:|:---:|
|Profession| python-developer|
|Article| About markup in the README|

[Back to Table of Contents](#Table-of-Contents)
____

Expand All @@ -253,6 +329,13 @@ The numbered list is created like regular line numbering,
3. third
4. fourth

### 5.3. CheckList
Implementing checklist is simply by using a dash "-" followed by a single space, then a square bracket [].
- Unchecked checklist: `- []` <br/>
e.g - [] Todo
- Checked checklist: `- [x]` <br/>
e.g - [x] Done

[Back to Table of Contents](#Table-of-Contents)
____
## Links
Expand Down Expand Up @@ -320,4 +403,4 @@ Here is your hidden text
```


</b></details>
</b></details>