Skip to content

Commit

Permalink
📌 ISSUE-#16 - Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FernandoCelmer committed Jan 21, 2023
1 parent 692d419 commit 1b41ded
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 10 deletions.
71 changes: 71 additions & 0 deletions docs/nav/setup/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
January 21, 2023

---

## Enable and Disable Components

### Site Name

- Default: true

```
theme:
components:
site_name: true
```

<button component-id="component-site-name" status="false"><code>true</code></button>
<button component-id="component-site-name" status="true"><code>false</code></button>

### Title

- Default: true

```
theme:
components:
title: true
```

<button component-id="component-title" status="false"><code>true</code></button>
<button component-id="component-title" status="true"><code>false</code></button>

### Menu

- Default: true

```
theme:
components:
menu: true
```

<button component-id="component-menu" status="false"><code>true</code></button>
<button component-id="component-menu" status="true"><code>false</code></button>

### Preview

- Default: true

```
theme:
components:
preview: true
```

<button component-id="component-preview" status="false"><code>true</code></button>
<button component-id="component-preview" status="true"><code>false</code></button>

### Footer

- Default: true

```
theme:
components:
footer: true
```

<button component-id="component-footer" status="false"><code>true</code></button>
<button component-id="component-footer" status="true"><code>false</code></button>

45 changes: 37 additions & 8 deletions docs/nav/setup/fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,59 @@ January 17, 2023

## Changing the fonts

### Title font format
### Site name style

- Default: normal

```
theme:
title_style: normal
site_name_style: normal
```

<button format-text="normal">
<button style-site-name="normal">
<code class="normal" style="background: var(--color-white); color: #000000 !important;">normal</code>
</button>
<button format-text="bold">
<button style-site-name="bold">
<code class="bold" style="background: var(--color-white); color: #000000 !important;">bold</code>
</button>
<button format-text="italic">
<button style-site-name="italic">
<code class="italic" style="background: var(--color-white); color: #000000 !important;">italic</code>
</button>
<button format-text="scratched">
<button style-site-name="scratched">
<code class="scratched" style="background: var(--color-white); color: #000000 !important;">scratched</code>
</button>
<button format-text="underline">
<button style-site-name="underline">
<code class="underline" style="background: var(--color-white); color: #000000 !important;">underline</code>
</button>
<button format-text="overline">
<button style-site-name="overline">
<code class="overline" style="background: var(--color-white); color: #000000 !important;">overline</code>
</button>


### Title style

- Default: bold

```
theme:
title_style: bold
```

<button style-title="normal">
<code class="normal" style="background: var(--color-white); color: #000000 !important;">normal</code>
</button>
<button style-title="bold">
<code class="bold" style="background: var(--color-white); color: #000000 !important;">bold</code>
</button>
<button style-title="italic">
<code class="italic" style="background: var(--color-white); color: #000000 !important;">italic</code>
</button>
<button style-title="scratched">
<code class="scratched" style="background: var(--color-white); color: #000000 !important;">scratched</code>
</button>
<button style-title="underline">
<code class="underline" style="background: var(--color-white); color: #000000 !important;">underline</code>
</button>
<button style-title="overline">
<code class="overline" style="background: var(--color-white); color: #000000 !important;">overline</code>
</button>
12 changes: 10 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ nav:
- Home: index.md
- Getting Started: nav/getting-started.md
- Setup:
- nav/setup/components.md
- nav/setup/colors.md
- nav/setup/fonts.md
- nav/setup/logo.md
Expand All @@ -18,12 +19,19 @@ nav:

theme:
name: simple-blog
title_style: normal
favicon: assets/favicon.ico
logo: assets/logo.png
# theme_style: light
theme_style: light
site_name_style: normal
title_style: bold
colors:
text: black
title: black
primary: black
background: white
components:
site_name: true
title: true
menu: true
preview: true
footer: true

0 comments on commit 1b41ded

Please sign in to comment.