Skip to content

Commit d023e39

Browse files
author
Laegel
committed
chore: Moved website/README.md to README.md
1 parent 316086f commit d023e39

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

website/README.md renamed to README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
This website was created with [Docusaurus](https://docusaurus.io/).
1+
# Tauri documentation
22

3-
# What's In This Document
3+
This website was created with [Docusaurus (1.X)](https://docusaurus.io/).
4+
5+
## What's In This Document
46

57
- [Get Started in 5 Minutes](#get-started-in-5-minutes)
68
- [Directory Structure](#directory-structure)
79
- [Editing Content](#editing-content)
810
- [Adding Content](#adding-content)
911
- [Full Documentation](#full-documentation)
1012

11-
# Get Started in 5 Minutes
13+
## Get Started in 5 Minutes
1214

1315
1. Make sure all the dependencies for the website are installed:
1416

@@ -24,7 +26,7 @@ $ yarn
2426
$ yarn start
2527
```
2628

27-
## Directory Structure
29+
### Directory Structure
2830

2931
Your project file structure should look something like this
3032

@@ -49,9 +51,9 @@ my-docusaurus/
4951
siteConfig.js
5052
```
5153

52-
# Editing Content
54+
## Editing Content
5355

54-
## Editing an existing docs page
56+
### Editing an existing docs page
5557

5658
Edit docs by navigating to `docs/` and editing the corresponding document:
5759

@@ -68,7 +70,7 @@ Edit me...
6870

6971
For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
7072

71-
## Editing an existing blog post
73+
### Editing an existing blog post
7274

7375
Edit blog posts by navigating to `website/blog` and editing the corresponding post:
7476

@@ -85,9 +87,9 @@ Edit me...
8587

8688
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
8789

88-
# Adding Content
90+
## Adding Content
8991

90-
## Adding a new docs page to an existing sidebar
92+
### Adding a new docs page to an existing sidebar
9193

9294
1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
9395

@@ -118,7 +120,7 @@ My new content here..
118120

119121
For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
120122

121-
## Adding a new blog post
123+
### Adding a new blog post
122124

123125
1. Make sure there is a header link to your blog in `website/siteConfig.js`:
124126

@@ -149,7 +151,7 @@ Lorem Ipsum...
149151

150152
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
151153

152-
## Adding items to your site's top navigation bar
154+
### Adding items to your site's top navigation bar
153155

154156
1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
155157

@@ -173,7 +175,7 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e
173175

174176
For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
175177

176-
## Adding custom pages
178+
### Adding custom pages
177179

178180
1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
179181
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
@@ -193,6 +195,10 @@ For more information about the navigation bar, click [here](https://docusaurus.i
193195

194196
For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
195197

196-
# Full Documentation
198+
## Full Documentation
197199

198200
Full documentation can be found on the [website](https://docusaurus.io/).
201+
202+
## Crowdin workflow
203+
204+
TBD

0 commit comments

Comments
 (0)