Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hydescarf committed Feb 23, 2023
1 parent 860e155 commit c14a1a3
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 24 deletions.
46 changes: 22 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,26 @@ Recommended fonts for this theme:
- Text: Segoe UI, Noto Sans
- Code: Fira Code

## Style Settings Available

![](img/stylesettings.png)

- Customizable theme colours, basic layout modifying, element hide-&-unhiding, and some basic markdown styling.


## Mado CSS Classes For Fun!
<details>
<summary><b>Mado-Heading</b></summary>
<summary><b>Mado Heading</b></summary>

![](img/mado-heading.png)

```
cssclass: mado-heading
```
Transforming your normal note into more bulky block button design!

</details>
<details>
<summary><b>Mado-Explorer</b></summary>
<summary><b>Mado Explorer</b></summary>

![](img/mado-explorer.png)

Expand All @@ -42,7 +48,7 @@ There are rules for this to work:
4. <li> will act as first level folder's children, where its contents should fill with just <a>, and itself should be placed below <h1>.
5. Second level folder, or nested <li>, is not possible.
6. For <h1> to be foldable, you have to enable the foldable option in the settings.
7. To make a solo-file below a folder list, use an empty <h1> to act as a separator.
```

Example:
Expand All @@ -58,16 +64,13 @@ Example:

</details>
<details>
<summary><b>Mado-Table</b></summary>
<summary><b>Mado Table</b></summary>

![](img/mado-table.png)

```
cssclass: mado-table
```

Turns your normal-looking table into a fancy spacious one! With more options provided for you to tweak the like of it.
Example:
```

```
cssclass: mado-table (special styling)
Expand All @@ -87,24 +90,22 @@ mado-table-topless (remove table-header position on the top)

</details>
<details>
<summary><b>Mado-Panel</b></summary>
<summary><b>Mado Panel</b></summary>

![](img/mado-panel.png)

```
cssclass: mado-panel
```

Turns your lists into panels! More fancy way to look and click. Also comes with options to tweak.
Example:

```
cssclass: mado-panel (transform all lists into panels)
cssclass: mado-panel-XXX (XXX being the options)
cssclass: mado-panel-XXX, mado-panel-XXX (including more options, in this case, only `auto` is available as an extra)
Options:
mado-panel-list (long and thin size, lists can be nested)
mado-panel-list-rightbox (the position of the checkbox in a list will be placed on the right instead of left)
mado-panel-small, mado-panel-medium, mado-panel-large, mado-panel-long, mado-panel-short (define fixed-size, lists cannot be nested)
mado-panel-auto (maintain the minimum fixed-size of above, while auto-widen based on its contents, not applicable to mado-panel-list)
mado-panel-link (turns link into a full button. Must not mix with plain text inside a single list)
Expand All @@ -115,7 +116,6 @@ Rule:
```
1. Only <li>(list) will turn into panel.
2. The list can consist of <a>(link) or "[]"(Checkbox), or plain text.
3. Nested list is not available except for `mado-panel-list`.
```
Callout version is also available if you need only one part of the list to become panel.
Options in callout version can be chained directly. (Only `auto` and `link` are currently available to be chained)
Expand All @@ -128,41 +128,41 @@ Example:

</details>
<details>
<summary><b>Mado-Timeline</b></summary>
<summary><b>Mado Timeline</b></summary>

![](img/mado-timeline.png)

```
cssclass: mado-timeline
```

Centers all of your element in the note! Not only that, using `<h1>` will form a huge space above it, while using `<h2>` will form a separator (a vertical `<hr>` or `---`) above it.

</details>
<details>
<summary><b>Mado-Daily</b></summary>
<summary><b>Mado Daily</b></summary>

![](img/mado-daily.png)

```
cssclass: mado-daily
```

![](img/mado-daily.png)

Feel like logging into a game to turn in for daily bonus? Well, now you can with this manual-stamp daily!
You can set the reward for every 2nd and 5th day, and then start filling in with any value or emoji in the empty cells. The reward will mark as checked when the previous cell is filled in.
Also, adding in another cssclass `mado-table` will give it a better looking, optional of course!

</details>
<details>
<summary><b>Mado-Table-Check & List2Table</b></summary>
<summary><b>Mado Table Check & List2Table</b></summary>

![](img/mado-table-check.png)

Stamp a checkmark by manually using "strikethrough" (`~~~~`/`<del></del>`) inside the block, either on the value or beside the value!

```
cssclass: mado-table-check
```

Stamp a checkmark by manually using "strikethrough" (`~~~~`/`<del></del>`) inside the block, either on the value or beside the value!
Don't like manually stamping? Then try out callout `mado-list2table`! By turning a list of checklists into a pseudo-table, you can now mark a check on the block by directly clicking onto it!

```
> [!mado-list2table]
Expand All @@ -171,6 +171,4 @@ Stamp a checkmark by manually using "strikethrough" (`~~~~`/`<del></del>`) insid
> - [ ] Checkboxes
```

Don't like manually stamping? Then try out callout `mado-list2table`! By turning a list of checklists into a pseudo-table, you can now mark a check on the block by directly clicking onto it!

</details>
Binary file modified img/stylesettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c14a1a3

Please sign in to comment.