Skip to content

Commit 7bb8af0

Browse files
committed
1 parent 812686b commit 7bb8af0

File tree

180 files changed

+4045
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

180 files changed

+4045
-0
lines changed

docs/CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.taio.app

docs/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Taio
2+
3+
This document provides instructions, tips and tricks for getting started with the [Taio](https://taio.app) app, as well as some reference examples.
4+
5+
We will keep this documentation updated to accommodate changes to the app, please stay tuned for our [What's New](whatsnew.md).
6+
7+
## FAQ
8+
9+
Some questions are asked a lot, we have prepared a [FAQ](faq.md) list for them and will keep it updated in future.
10+
11+
## Dev Notes
12+
13+
Want to learn more about how do we build the app? We'd love to share!
14+
15+
We have built [Taio Dev Notes](https://dev.taio.app) for knowledge sharing, technical articles will be posted there.
16+
17+
## Contact Us
18+
19+
Feel free to reach us out:
20+
21+
- Email: [hi@taio.app](mailto:hi@taio.app)
22+
- Twitter: https://twitter.com/TaioApp

docs/_asset/favicon.png

1.1 KB
Loading

docs/_js/index.js

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
window.$docsify = {
2+
themeColor: '#ff9500',
3+
alias: {
4+
'/((?!cn).)*/_sidebar.md': '/_sidebar.md',
5+
'/((?!cn).)*/_navbar.md': '/_navbar.md',
6+
'/cn/.*/_sidebar.md': '/cn/_sidebar.md',
7+
'/cn/.*/_navbar.md': '/cn/_navbar.md'
8+
},
9+
auto2top: true,
10+
coverpage: false,
11+
executeScript: true,
12+
loadSidebar: true,
13+
loadNavbar: true,
14+
mergeNavbar: true,
15+
maxLevel: 4,
16+
subMaxLevel: 2,
17+
name: 'Taio',
18+
search: {
19+
noData: {
20+
'/cn/': '没有结果',
21+
'/': 'No results'
22+
},
23+
paths: 'auto',
24+
placeholder: {
25+
'/cn/': '搜索',
26+
'/': 'Search'
27+
}
28+
},
29+
formatUpdated: '{MM}/{DD} {HH}:{mm}',
30+
externalLinkTarget: '_self',
31+
plugins: [
32+
EditOnGithubPlugin.create('https://github.com/cyanzhong/docs.taio.app/blob/master/docs/', null, path => {
33+
if (path.indexOf('cn/') === 0) {
34+
return '在 GitHub 上编辑';
35+
} else {
36+
return 'Edit on GitHub';
37+
}
38+
}),
39+
(hook, vm) => {
40+
hook.beforeEach(async(content, next) => {
41+
const path = vm.route.path;
42+
if (path.indexOf('/editor/math') !== -1) {
43+
await loadPlugin('mathjax/2.7.9/MathJax.js?config=TeX-MML-AM_CHTML');
44+
} else if (path.indexOf('/editor/diagrams') !== -1) {
45+
const plugins = [
46+
'raphael/2.3.0/raphael.min.js',
47+
'underscore.js/1.11.0/underscore-min.js',
48+
'js-sequence-diagrams/1.0.6/sequence-diagram-min.js',
49+
'flowchart/1.15.0/flowchart.min.js',
50+
'mermaid/8.8.4/mermaid.min.js'
51+
];
52+
for (const src of plugins) {
53+
await loadPlugin(src);
54+
}
55+
}
56+
next(content);
57+
});
58+
hook.doneEach(() => {
59+
renderMathJax();
60+
renderDiagrams();
61+
});
62+
}
63+
]
64+
};
65+
66+
function loadPlugin(path) {
67+
return new Promise(resolve => {
68+
const script = document.createElement('script');
69+
script.onload = resolve;
70+
script.src = `https://cdnjs.cloudflare.com/ajax/libs/${path}`;
71+
document.head.appendChild(script);
72+
});
73+
}

docs/_js/plugins.js

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
function renderMathJax() {
2+
if (typeof MathJax !== 'undefined') {
3+
MathJax.Hub.Config({
4+
extensions: ['tex2jax.js'],
5+
jax: ['input/TeX', 'output/HTML-CSS'],
6+
tex2jax: {
7+
inlineMath: [
8+
['$', '$'],
9+
['\\(', '\\)']
10+
],
11+
displayMath: [
12+
['$$', '$$'],
13+
['\\[', '\\]']
14+
],
15+
processEscapes: true
16+
},
17+
'HTML-CSS': {availableFonts: ['TeX']}
18+
});
19+
MathJax.Hub.Queue(['Typeset', MathJax.Hub]);
20+
}
21+
}
22+
23+
function renderDiagrams() {
24+
if (typeof Diagram !== 'undefined') {
25+
const sequences = document.querySelectorAll('code[class=lang-sequence]');
26+
sequences.forEach((sequence, index) => {
27+
const diagram = Diagram.parse(sequence.textContent);
28+
const canvas = document.createElement('div');
29+
canvas.id = `diagram-${index}`;
30+
canvas.className = 'sequence';
31+
const container = sequence.parentNode;
32+
container.parentNode.replaceChild(canvas, container);
33+
diagram.drawSVG(canvas.id, {theme: 'simple'});
34+
});
35+
}
36+
37+
if (typeof flowchart !== 'undefined') {
38+
const charts = document.querySelectorAll('code[class=lang-flow]');
39+
charts.forEach((chart, index) => {
40+
const diagram = flowchart.parse(chart.textContent);
41+
const canvas = document.createElement('div');
42+
canvas.id = `flowchart-${index}`;
43+
canvas.className = 'flowchart';
44+
const container = chart.parentNode;
45+
container.parentNode.replaceChild(canvas, container);
46+
diagram.drawSVG(canvas.id);
47+
});
48+
}
49+
50+
if (typeof mermaid !== 'undefined') {
51+
mermaid.mermaidAPI.initialize({
52+
startOnLoad: false
53+
});
54+
55+
const charts = document.querySelectorAll('code[class=lang-mermaid]');
56+
charts.forEach((chart, index) => {
57+
const canvas = document.createElement('div');
58+
canvas.id = `mermaid-${index}`;
59+
canvas.className = 'mermaid';
60+
const container = chart.parentNode;
61+
container.parentNode.replaceChild(canvas, container);
62+
mermaid.mermaidAPI.render(canvas.className, chart.textContent, svg => {
63+
canvas.innerHTML = svg;
64+
});
65+
});
66+
}
67+
}

docs/_navbar.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [What's New](whatsnew.md)
2+
- [**EN** / CN](cn/)

docs/_sidebar.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
- Quick Start
2+
- [README](README.md)
3+
- [FAQ](faq.md)
4+
- [Introduction](intro.md)
5+
- [Clipboard](quick-start/clipboard.md)
6+
- [Editor](quick-start/editor.md)
7+
- [Actions](quick-start/actions.md)
8+
- Editor
9+
- [Hello, Markdown](editor/hello-markdown.md)
10+
- [Pro Tips](editor/pro-tips.md)
11+
- [Command Palette](editor/command-palette.md)
12+
- [Tags](editor/tags.md)
13+
- [Search](editor/search.md)
14+
- [Math Formulas](editor/math.md)
15+
- [Diagrams](editor/diagrams.md)
16+
- [Image Uploading](editor/image-uploading.md)
17+
- [Keyboard Shortcuts](editor/cheatsheet.md)
18+
- Text Actions
19+
- [Basics](actions/basics.md)
20+
- [Categories](actions/categories.md)
21+
- [Template Strings](actions/template-strings.md)
22+
- [Control Flow](actions/control-flow.md)
23+
- [Variables](actions/variables.md)
24+
- [Advanced Scripting](actions/scripting.md)
25+
- App Integration
26+
- [Shortcuts](integration/shortcuts.md)
27+
- [Working Copy](integration/working-copy.md)
28+
- [TextExpander](integration/text-expander.md)
29+
- [URL Schemes](integration/url-schemes.md)
30+
- Privacy & Terms
31+
- [Private Policy](privacy.md)
32+
- [Terms of Service](terms.md)

0 commit comments

Comments
 (0)