You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First install the mkdocs and mkdocs-material theme in your python virtual environment:
6
+
```
7
+
pip install -r requirements.txt
8
+
```
9
+
Then, navigate to the `/mindsdb-docs` directory and start the server:
10
+
11
+
```
12
+
mkdocs serve
13
+
```
14
+
15
+
The documentation website will be available at `http://127.0.0.1:8000`
16
+
17
+
18
+
## Deploy the docs
19
+
20
+
The latest version shall be automatically pushed and deployed after merge on master. If the CI/CD deploy failed, locally run:
21
+
22
+
```
23
+
mkdocs gh-deploy
24
+
```
25
+
26
+
All of the html files and assets will be pushed to the [gh-pages](https://github.com/mindsdb/mindsdb-docs/tree/gh-pages) branch and published on github pages.
27
+
28
+
## Repository structure
29
+
30
+
The mindsdb-docs layout is as follows:
31
+
32
+
```
33
+
docs # Containes documentation source files
34
+
|__assets/ # Image and icons used in pages
35
+
|__.md # All of the markdown files used as pages
36
+
overrides
37
+
├─ assets/
38
+
│ ├─ images/ # Images and icons
39
+
│ ├─ javascripts/ # JavaScript
40
+
│ └─ stylesheets/ # Stylesheets
41
+
├─ partials/
42
+
│ ├─ footer.html # Footer bar
43
+
├─ 404.html # 404 error page
44
+
├─ base.html # Base template
45
+
└─ main.html
46
+
.mkdocs.yml # Mkdocs configuration file
47
+
```
48
+
# Contribute
49
+
50
+
## How can you help us? [](https://github.com/mindsdb/mindsdb/issues)
0 commit comments