Skip to content

Commit 3aad6d1

Browse files
authored
feat(#153): Added documentation & structure (#1)
* Removed content * Added User Guide content * Added Testing Guide content * Added SQLite DB Guide content * Added 404 page * Added Introduction page * Added summary & toml file * Added gitignore * Cleanup
1 parent e65f604 commit 3aad6d1

23 files changed

+451
-38
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

book.toml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
[book]
2-
title = "Njord - A lightweight ORM library in Rust"
3-
authors = ["Marcus Cvjeticanin"]
2+
authors = ["Marcus Cvjeticanin", "Christopher Zeuch"]
3+
title = "Njord"
44
description = "A lightweight ORM library in Rust with strong-typed SQL DSL and sequence API."
55
language = "en"
6-
git-repository-url = "https://github.com/mjovanc/njord"
6+
multilingual = false
7+
git-repository-url = "https://github.com/njord-rs/docs"
78
git-repository-icon = "fa-github"
8-
copy-fonts = true
9-
edit-url-template = "https://github.com/mjovanc/njord/tree/docs/src/{path}"
10-
cname = "njord.rs"
11-
input-404 = "not-found.md"
9+
src = "src"
10+
input-404 = "404.md"
11+
12+
[output.html]
13+
copy-code = true
1214

1315
[build]
14-
target-dir = "book"
16+
target-dir = "book"

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/README.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/src/SUMMARY.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/src/not-found.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/sqlite/sqlite.md

Whitespace-only changes.

src/404.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 😵 404
2+
3+
The page you are looking for does not exist.

src/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Introduction
2+
3+
A lightweight ORM library in Rust with strong-typed SQL DSL and sequence API.
4+
5+
We support the following databases:
6+
7+
| Database | Support |
8+
| ---------- | :-------: |
9+
| SQLite ||
10+
| PostgreSQL ||
11+
| MySQL ||
12+
| MariaDB ||
13+
| Oracle ||
14+
| MSSQL ||
15+
16+
## ✨ Contributors
17+
18+
We'd like to take a moment to recognize our awesome contributors:
19+
20+
[<img src="https://github.com/mjovanc.png?size=72" alt="mjovanc" width="72">](https://github.com/mjovanc)
21+
[<img src="https://github.com/appelskrutt34.png?size=72" alt="appelskrutt34" width="72">](https://github.com/appelskrutt34)
22+
[<img src="https://avatars.githubusercontent.com/u/23294573?v=4&size=72">](https://github.com/ahsentekd)
23+
[<img src="https://avatars.githubusercontent.com/u/167654108?v=4&size=72">](https://github.com/chinmer)
24+
[<img src="https://github.com/SvMak.png?size=72" alt="SvMak" width="72">](https://github.com/SvMak)
25+
[<img src="https://github.com/TomasWild.png?size=72" alt="TomasWild" width="72">](https://github.com/TomasWild)
26+
[<img src="https://github.com/chaseWillden.png?size=72" alt="chaseWillden" width="72">](https://github.com/chaseWillden)
27+
[<img src="https://github.com/Hiccup-za.png?size=72" alt="Hiccup-za" width="72">](https://github.com/Hiccup-za)
28+
29+
## 🤝 Contributing
30+
31+
Help us implement support for these databases and more!
32+
33+
Please first talk to us in [Discord](https://discord.gg/AbK57nAGv8) about what you are planning to do so we both save time and effort. If it's only bug fixes or documentation, feel free to submit a PR.
34+
35+
## 📄 License
36+
37+
The BSD 3-Clause License.

src/SUMMARY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Summary
2+
3+
[Introduction](README.md)
4+
5+
# ⚡️ Getting Started
6+
- [Installation](user-guides/installation.md)
7+
- [Add a schema file](user-guides/add-schema.md)
8+
9+
# 📚 Database Guides
10+
- [SQLite](db-guides/sqlite/sqlite.md)
11+
- [Connection](db-guides/sqlite/connection.md)
12+
- [Initialize a database](db-guides/sqlite/initialize-database-with-tables.md)
13+
- [Define Tables](db-guides/sqlite/define-tables.md)
14+
- [Insert](db-guides/sqlite/insert.md)
15+
- [Select](db-guides/sqlite/select.md)
16+
- [Drop](db-guides/sqlite/drop.md)
17+
18+
# 🧪 Testing Guides
19+
- [Test Structure](testing-guides/test-structure.md)
20+
- [Running Tests](testing-guides/running-tests.md)
21+
- [Adding New Tests](testing-guides/adding-new-tests.md)

0 commit comments

Comments
 (0)