Skip to content

Commit 8dd9cfc

Browse files
Add readme, gitignore, CNAME
1 parent 6ca45a4 commit 8dd9cfc

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

docs/.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Environments
2+
.env
3+
.venv
4+
env/
5+
venv/
6+
ENV/
7+
env.bak/
8+
venv.bak/
9+
mindsdb-docs/site/

docs/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# MindsDB Documentation
2+
3+
## Running the docs locally
4+
5+
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? [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/mindsdb/mindsdb/issues)
51+
52+
* Report a bug
53+
* Improve documentation
54+
* Propose new feature
55+
* Fix typos
56+
57+
## Contributors
58+
59+
<a href="https://github.com/mindsdb/mindsdb-docs/graphs/contributors">
60+
<img src="https://contributors-img.web.app/image?repo=mindsdb/mindsdb-docs" />
61+
</a>
62+
63+
Made with [contributors-img](https://contributors-img.web.app).

docs/mindsdb-docs/docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.mindsdb.com

0 commit comments

Comments
 (0)