Skip to content

Commit f13530b

Browse files
committed
Merge branch 'restructure-part1' of https://github.com/ronzulu/talon-community-wiki into restructure-part1
2 parents 579cc52 + 132ddda commit f13530b

File tree

5 files changed

+95
-91
lines changed

5 files changed

+95
-91
lines changed

docs/Resource Hub/Talon Installation/installation_guide.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ some steps are specific to the Talon community user file set, and will be marked
1111

1212
:::
1313

14-
1514
## 1: Check System Requirements
1615

1716
Talon has various [system requirements](../Hardware/os), covering the computer hardware, operating system and microphone hardware.
@@ -87,9 +86,6 @@ If you install a different user file set then portions of this wiki will not be
8786
These will be marked as such.
8887
:::
8988

90-
91-
92-
9389
A `user file set` is simply a bunch of files that need to be downloaded and placed in the correct directory -
9490
the Talon user directory.
9591
<!-- Update in later phase of https://github.com/TalonCommunity/Wiki/pull/312
@@ -111,10 +107,9 @@ If you have installed a different user file set, consult its documentation on us
111107

112108
## 6: Next steps
113109

114-
115110
- If needed, try ways to [improve recognition accuracy](../Speech%20Recognition/improving_recognition_accuracy.md)
116111
- [Customize Talon](../../Customization/basic_customization): learn about how to configure Talon to your liking.
117-
- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
112+
- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
118113
- For earlier access to new features, priority support, and access to additional [speech engines](../Speech%20Recognition/speech%20engines.md), install the [beta version](../../Help/beta_talon).
119114

120115
<!-- Update in later phase of https://github.com/TalonCommunity/Wiki/pull/312

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ const config: Config = {
8686
removeDefaultStemmer: true,
8787
},
8888
],
89-
"@docusaurus/theme-mermaid"
89+
"@docusaurus/theme-mermaid",
9090
],
9191
themeConfig: {
9292
// Replace with your project's social card

src/css/custom.css

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,55 +6,55 @@
66

77
/* You can override the default Infima variables here. */
88
:root {
9-
--ifm-color-primary: #2e8555;
10-
--ifm-color-primary-dark: #29784c;
11-
--ifm-color-primary-darker: #277148;
12-
--ifm-color-primary-darkest: #205d3b;
13-
--ifm-color-primary-light: #33925d;
14-
--ifm-color-primary-lighter: #359962;
15-
--ifm-color-primary-lightest: #3cad6e;
16-
--ifm-code-font-size: 95%;
17-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
18-
}
19-
20-
/* For readability concerns, you should choose a lighter palette in dark mode. */
21-
[data-theme="dark"] {
22-
--ifm-color-primary: #25c2a0;
23-
--ifm-color-primary-dark: #21af90;
24-
--ifm-color-primary-darker: #1fa588;
25-
--ifm-color-primary-darkest: #1a8870;
26-
--ifm-color-primary-light: #29d5b0;
27-
--ifm-color-primary-lighter: #32d8b4;
28-
--ifm-color-primary-lightest: #4fddbf;
29-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
30-
}
31-
32-
.hidden {
33-
display: none !important;
34-
}
9+
--ifm-color-primary: #2e8555;
10+
--ifm-color-primary-dark: #29784c;
11+
--ifm-color-primary-darker: #277148;
12+
--ifm-color-primary-darkest: #205d3b;
13+
--ifm-color-primary-light: #33925d;
14+
--ifm-color-primary-lighter: #359962;
15+
--ifm-color-primary-lightest: #3cad6e;
16+
--ifm-code-font-size: 95%;
17+
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
18+
}
19+
20+
/* For readability concerns, you should choose a lighter palette in dark mode. */
21+
[data-theme="dark"] {
22+
--ifm-color-primary: #25c2a0;
23+
--ifm-color-primary-dark: #21af90;
24+
--ifm-color-primary-darker: #1fa588;
25+
--ifm-color-primary-darkest: #1a8870;
26+
--ifm-color-primary-light: #29d5b0;
27+
--ifm-color-primary-lighter: #32d8b4;
28+
--ifm-color-primary-lightest: #4fddbf;
29+
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
30+
}
31+
32+
.hidden {
33+
display: none !important;
34+
}
3535

3636
[data-theme="dark"] pre {
3737
color: var(--shiki-dark) !important;
3838
background-color: var(--shiki-dark-bg) !important;
3939
}
4040
[data-theme="dark"] pre span {
41-
color: var(--shiki-dark) !important;
41+
color: var(--shiki-dark) !important;
4242
}
4343

4444
.theme-admonition.docotodo {
45-
background-color: rgb(121, 68, 146);
46-
border-left: 4px solid rgb(58, 23, 73);
47-
color: white;
45+
background-color: rgb(121, 68, 146);
46+
border-left: 4px solid rgb(58, 23, 73);
47+
color: white;
4848
}
4949

5050
.theme-admonition.docofeedback {
51-
background-color: rgb(92, 104, 61);
52-
border-left: 4px solid rgb(4, 43, 7);
53-
color: white;
51+
background-color: rgb(92, 104, 61);
52+
border-left: 4px solid rgb(4, 43, 7);
53+
color: white;
5454
}
5555

5656
.theme-admonition.docoscope {
57-
background-color: #373255;
58-
border-left: 4px solid #651FFF;
59-
color: white;
57+
background-color: #373255;
58+
border-left: 4px solid #651fff;
59+
color: white;
6060
}

src/pages/index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Talon is free to use and ongoing development is made possible by [donations on P
1010

1111
## Talon Landscape
1212

13-
1413
```mermaid
1514
mindmap
1615
root{{"Talon Platform<br/>talonvoice.com"}}
@@ -39,13 +38,14 @@ mindmap
3938
Stream Deck
4039
4140
```
41+
4242
---
4343

4444
## Jumping In
4545

4646
Before installing Talon, there is useful information on this page and on the linked pages for you to read.
4747

48-
If you prefer jumping in, here is the [installation guide](/Resource%20Hub/Talon%20Installation/installation_guide) and
48+
If you prefer jumping in, here is the [installation guide](/Resource%20Hub/Talon%20Installation/installation_guide) and
4949
information about [basic usage](/Basic%20Usage/basic_usage).
5050

5151
---
@@ -75,7 +75,6 @@ of this wiki is relevant. Those that are will be highlighted as follows.
7575
</div>
7676
</div>
7777

78-
7978
---
8079

8180
## Goal of this Wiki
@@ -86,14 +85,14 @@ The goal of this wiki is to provide information and documentation for the users
8685

8786
## Wiki Navigation
8887

89-
| If you are looking for: | See: |
90-
| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
91-
| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
92-
| Help with deciding on a microphone or eye tracker | [Hardware](/Resource%20Hub/Hardware) |
88+
| If you are looking for: | See: |
89+
| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
90+
| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
91+
| Help with deciding on a microphone or eye tracker | [Hardware](/Resource%20Hub/Hardware) |
9392
| Installing and getting started with Talon | [Installing Talon](/Resource%20Hub/Talon%20Installation/installation_guide), [Basic Usage](/Basic%20Usage/basic_usage) |
94-
| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/basic_customization), [Integrations](/Integrations/essential-tools) |
95-
| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Speech%20Recognition/troubleshooting) |
96-
| Answers to frequently asked questions | [FAQ](/Help/FAQ) |
93+
| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/basic_customization), [Integrations](/Integrations/essential-tools) |
94+
| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Speech%20Recognition/troubleshooting) |
95+
| Answers to frequently asked questions | [FAQ](/Help/FAQ) |
9796

9897
:::tip Talon Slack
9998

src/theme/Admonition/Type/Info.tsx

Lines changed: 48 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,59 @@
1-
import React, {type ReactNode} from 'react';
2-
import Info from '@theme-original/Admonition/Type/Info';
3-
import type InfoType from '@theme/Admonition/Type/Info';
4-
import type {WrapperProps} from '@docusaurus/types';
1+
import React, { type ReactNode } from "react";
2+
import Info from "@theme-original/Admonition/Type/Info";
3+
import type InfoType from "@theme/Admonition/Type/Info";
4+
import type { WrapperProps } from "@docusaurus/types";
55

66
type Props = WrapperProps<typeof InfoType>;
77

88
function ScopeIcon() {
9-
return (
10-
<svg viewBox="0 0 24 24">
11-
<path d="M4 12H4.01M8 12H8.01M16 12H16.01M12 12H12.01M20 12H20.01M8.5 4H7.2C6.0799 4 5.51984 4 5.09202 4.21799C4.71569 4.40973 4.40973 4.71569 4.21799 5.09202C4 5.51984 4 6.0799 4 7.2V8.5M15.5 4H16.8C17.9201 4 18.4802 4 18.908 4.21799C19.2843 4.40973 19.5903 4.71569 19.782 5.09202C20 5.51984 20 6.07989 20 7.2V8.5M20 15.5V16.8C20 17.9201 20 18.4802 19.782 18.908C19.5903 19.2843 19.2843 19.5903 18.908 19.782C18.4802 20 17.9201 20 16.8 20H15.5M4 15.5V16.8C4 17.9201 4 18.4802 4.21799 18.908C4.40973 19.2843 4.71569 19.5903 5.09202 19.782C5.51984 20 6.0799 20 7.2 20H8.5"
12-
stroke="#ffffff" strokeWidth="1" strokeLinecap="round" strokeLinejoin="round"/>
13-
</svg>
14-
);
9+
return (
10+
<svg viewBox="0 0 24 24">
11+
<path
12+
d="M4 12H4.01M8 12H8.01M16 12H16.01M12 12H12.01M20 12H20.01M8.5 4H7.2C6.0799 4 5.51984 4 5.09202 4.21799C4.71569 4.40973 4.40973 4.71569 4.21799 5.09202C4 5.51984 4 6.0799 4 7.2V8.5M15.5 4H16.8C17.9201 4 18.4802 4 18.908 4.21799C19.2843 4.40973 19.5903 4.71569 19.782 5.09202C20 5.51984 20 6.07989 20 7.2V8.5M20 15.5V16.8C20 17.9201 20 18.4802 19.782 18.908C19.5903 19.2843 19.2843 19.5903 18.908 19.782C18.4802 20 17.9201 20 16.8 20H15.5M4 15.5V16.8C4 17.9201 4 18.4802 4.21799 18.908C4.40973 19.2843 4.71569 19.5903 5.09202 19.782C5.51984 20 6.0799 20 7.2 20H8.5"
13+
stroke="#ffffff"
14+
strokeWidth="1"
15+
strokeLinecap="round"
16+
strokeLinejoin="round"
17+
/>
18+
</svg>
19+
);
1520
}
1621

1722
export default function InfoWrapper(props: Props): ReactNode {
18-
const { title, children } = props;
23+
const { title, children } = props;
1924

20-
let scope = null;
21-
let body = null;
22-
if (props.title == "talon-scope-platform") {
23-
scope = "Talon Platform";
24-
body = `This section is relevant to all users of the talon platform, regardless of whether or not the Talon community user file set
25+
let scope = null;
26+
let body = null;
27+
if (props.title == "talon-scope-platform") {
28+
scope = "Talon Platform";
29+
body = `This section is relevant to all users of the talon platform, regardless of whether or not the Talon community user file set
2530
has also been installed.`;
26-
} else if (props.title == "talon-scope-community") {
27-
scope = "Talon Community User File Set";
28-
body = (<span>This section is only relevant to users who have installed the
29-
<a href="Resource Hub/Talon Installation/downloading-community">Talon community user file set</a></span>);
30-
} else if (props.title == "talon-scope") {
31-
scope = "";
32-
body = children;
33-
}
34-
const isCustom = Boolean(body);
35-
const heading = isCustom ? `[SCOPE] ${scope}` : null;
36-
37-
38-
return (
39-
<>
40-
{ isCustom ?
41-
<Info icon={<ScopeIcon />} className="docoscope" title={heading} >
42-
{body}
43-
</Info>
44-
:
45-
<Info {...props} />
46-
}
47-
</>
31+
} else if (props.title == "talon-scope-community") {
32+
scope = "Talon Community User File Set";
33+
body = (
34+
<span>
35+
This section is only relevant to users who have installed the
36+
<a href="Resource Hub/Talon Installation/downloading-community">
37+
Talon community user file set
38+
</a>
39+
</span>
4840
);
41+
} else if (props.title == "talon-scope") {
42+
scope = "";
43+
body = children;
44+
}
45+
const isCustom = Boolean(body);
46+
const heading = isCustom ? `[SCOPE] ${scope}` : null;
47+
48+
return (
49+
<>
50+
{isCustom ? (
51+
<Info icon={<ScopeIcon />} className="docoscope" title={heading}>
52+
{body}
53+
</Info>
54+
) : (
55+
<Info {...props} />
56+
)}
57+
</>
58+
);
4959
}

0 commit comments

Comments
 (0)