Skip to content

Commit

Permalink
docs: fix ui & typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ammarahm-ed authored and thecodrr committed Jun 22, 2023
1 parent ce1bc83 commit 41f0a4e
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 22 deletions.
39 changes: 32 additions & 7 deletions docs/help/contents/_include/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -116,35 +116,56 @@ html.light {
--header-fg: #008837;
--link: #008837;
--heading: #000;
--page-bg: #fafafa;
--document-bg: #f3f3f3;
--page-bg: #ffffff;
--document-bg: #f7f7f7;
--selection-bg: #00883766;
--selection-fg: #fff;
--border: #e8e8e8;
--input-border: #e8e8e8;

--hover-bg: #e8e8e8;
--info-dim: #00883720;

--fg: #403f53;
--fg-dim: #403f53cc;
--fg-dimmer: #403f53bb;
--code-bg: #e8e8e8;
}

html.dark {
--font-family: "Open Sans", sans-serif;
--monospace-font-family: "Fira Code", monospace;
--primary: #008837;
--primary-fg: #fff;
--header-fg: #008837;
--link: #008837;
--page-bg: #1b1b1b;
--document-bg: #222;
--border: #333;
--page-bg: #0d0d0d;
--document-bg: #151515;
--border: #383838;

--info-dim: #00883720;

--button-bg: #3b3b3b;
--hover-bg: #4b4b4b;
--hover-bg: #202020;
--button-fg: #fff;

--input-bg: #2b2b2b;
--input-placeholder: #ababab;

--code-bg: #4b4b4b;
--code-bg: #202020;
--selection-bg: #00883766;
--selection-fg: #fff;
--border-dim: #383838;
--input-border: #383838;
--input-bg: #151515;
}

nav li:not(li.nested):hover {
background-color: var(--hover-bg);
}

pre {
border: 1px solid var(--border);
}

.project-title a {
Expand All @@ -156,3 +177,7 @@ html.dark {
color: var(--fg);
font-weight: 600;
}

.docgen-content {
box-shadow: none;
}
36 changes: 25 additions & 11 deletions docs/help/contents/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,27 +37,41 @@ Once installation completes, you can start Notesnook app from the Launchpad.

## Windows

# [Download .exe](#/tab/exe)
# [Installing via .exe files](#/tab/exe)

Download the latest `.exe` file from the link below.
Download the latest **.exe** file from the links below:

- [Notesnook](https://notesnook.com/releases/windows/notesnook_win_x64.exe)
- [Notesnook portable](https://notesnook.com/releases/windows/notesnook_win_x64_portable.exe)
- [Notesnook x64 (Setup)](https://notesnook.com/releases/windows/notesnook_win_x64.exe)
- [Notesnook x64 (Portable)](https://notesnook.com/releases/windows/notesnook_win_x64_portable.exe)

Once you have the .exe downloaded,
Once you have the **.exe** downloaded:

1. Double click to open the .exe file
2.
1. Double click to open the **.exe** file
2. Follow the installation instructions to install the app.

# [Install via Chocolatey](#/tab/choco)
# [Installing via PowerShell](#/tab/terminal)

If you have [Chocolatey](https://chocolatey.org/) installed on windows you can quickly install Notesnook via powershell:
To install Notesnook, run the following command from the command line or from PowerShell:

```
#### [Chocolatey](https://community.chocolatey.org/packages/notesnook)

```bash
choco install notesnook
```

Start Notesnook from Windows Search.
#### [Winget](https://winget.run/pkg/Streetwriters/Notesnook)

```bash
winget install -e --id Streetwriters.Notesnook
```

#### [Scoop](https://scoop.sh/#/apps?q=notesnook&s=0&d=1&o=true)

```bash
scoop bucket add extras && scoop install notesnook
```

Start Notesnook from Windows Start Menu.

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Notebooks consist of topics where you can add/create and edit your notes.

> info
>
> Once a note is added to a notebook, it's refernence will show on top of the note in the list. Clicking on it will take you to the topic.
> Once a note is added to a notebook, it's references will show on top of the note in the list. Clicking on it will take you to the topic.
>
> ![Notebook reference on a note](/notebook-ref.png)
Expand All @@ -125,7 +125,6 @@ Notebooks consist of topics where you can add/create and edit your notes.
2. Select `Add to Notebook(s)`
3. Select the notebook and topic in which you want to add the note
4. Click "Finish" to add the notes to the topic.

5. You should now see the notebook/topic below the note title. You can click on it to navigate to the topic directly.

# [Mobile](#/tab/mobile)
Expand All @@ -134,7 +133,6 @@ Notebooks consist of topics where you can add/create and edit your notes.
2. Press on `Add to notebook` button.
3. Select the notebook and topic in which you want to add the note.
4. Once done, swipe down to close the sheet.

5. You should now see the notebook/topic on the top left side of the note. You can click on it to navigate to the topic directly.

---
Expand Down
2 changes: 1 addition & 1 deletion docs/help/docgen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ navigation:
- path: desktop-integration/auto-start-on-system-startup.md
- path: desktop-integration/jumplist-and-dock-menu.md
- path: desktop-integration/spell-checker.md
- path: desktop-integration/system-tray-menu.md
- path: desktop-integration/system-tray-menu.md

0 comments on commit 41f0a4e

Please sign in to comment.