Skip to content

Commit 5330786

Browse files
TimoBechtelTimoBechtel
committed
docs: add documentation page
1 parent e069c05 commit 5330786

3 files changed

Lines changed: 52 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,22 @@ However, it can't (yet):
5050

5151
## Install
5252

53-
### NPM:
53+
<!-- tabs:start -->
54+
55+
### npm
56+
57+
```sh
58+
npm install satzbau
59+
```
60+
61+
### yarn
5462

5563
```sh
56-
yarn install satzbau
64+
yarn add satzbau
5765
```
5866

67+
<!-- tabs:end -->
68+
5969
## Usage
6070

6171
> Note: satzbau provides pure functions, meaning every function call will not change the object in-place, but instead return a new object.
@@ -265,7 +275,7 @@ yarn run test
265275

266276
👤 **Timo Bechtel**
267277

268-
- Website: https://timobechtel.com
278+
- Website: <https://timobechtel.com>
269279
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
270280
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
271281

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/index.html‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<title>Satzbau</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta
8+
name="description"
9+
content="satzbau allows you to generate natural sounding texts in German"
10+
/>
11+
<meta
12+
name="viewport"
13+
content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
14+
/>
15+
<link
16+
rel="stylesheet"
17+
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
18+
/>
19+
</head>
20+
<body>
21+
<div id="app">Loading...</div>
22+
<script>
23+
window.$docsify = {
24+
name: '🏗 Satzbau',
25+
repo: 'https://github.com/TimoBechtel/satzbau',
26+
homepage:
27+
'https://raw.githubusercontent.com/TimoBechtel/satzbau/main/README.md',
28+
copyCode: {
29+
buttonText: 'Copy',
30+
},
31+
};
32+
</script>
33+
<!-- Docsify v4 -->
34+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
35+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
36+
<script src="//cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
37+
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
38+
</body>
39+
</html>

0 commit comments

Comments
 (0)