Skip to content

Commit 77e1197

Browse files
committed
Custom color for docs
1 parent 425401d commit 77e1197

10 files changed

+59
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.old.png)
1+
![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.png)
22

33
# Introduction
44

docs/Single_file.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Single file
2+
3+
TODO: In the future I will migrate into a single file database like SQLite.
4+
5+
## FileVar
6+
7+
A FileVar is a single value but saved in a file. This have a Blok, a position, a size and a type.
8+
For string, I will create something different I think, with a size max and a len, and can request more if needed.
9+
10+
## FileBlok
11+
12+
A blok is like memory but for file. It has a starting point and a size and can hold entities or FileVar.
13+
Everything I will save will be linked into a Blok and I can create and delete it at will. The size it given in the config and can't change.
14+
15+
In SQLite, it is what they call a page I think. Similare thing.

docs/Technical docs.md

+4
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,10 @@ A condition have those infos:
220220
NewData is a map with member name as key and ConditionValue as value, it is created when parsing and is use to add data into a file.
221221
I transform ConditionValue into Zid Data. Maybe I can directly do a map member name -> zid Data ?
222222

223+
### RelationMap
224+
225+
TODO: Explain.
226+
223227
## EntityWriter
224228

225229
This is responsable to transform the raw Data into a JSON, Table or other output format to send send to end user.

docs/features.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Features
2+
3+
TODO

docs/images/banner.old.png

-740 KB
Binary file not shown.

docs/images/banner.png

226 KB
Loading

docs/images/banner_white.png

-289 KB
Binary file not shown.

docs/release.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Release
2+
3+
## 0.1.8
4+
5+
First release.
6+
7+
Mostly to test the release pipeline with Github actions.
8+
Only include CLI, most ZiQL features here but still missing some part.
9+
Mostly missing thing around the database to make it usable.

docs/stylesheets/extra.css

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:root {
2+
--md-primary-fg-color: #FEFADF;
3+
--md-primary-fg-color--light: #FCFBF2;
4+
--md-primary-fg-color--dark: #E3C797;
5+
6+
--md-primary-bg-color: #000000;
7+
--md-typeset-a-color: #000000;
8+
}
9+
10+
[data-md-color-scheme="default"] {
11+
--md-typeset-a-color: #c57d00;
12+
}

mkdocs.yml

+15-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
site_name: "Documentation"
12
site_url: https://MrBounty.github.io/ZipponDB/
23
repo_url: https://github.com/MrBounty/ZipponDB
34
theme:
@@ -13,18 +14,21 @@ theme:
1314
palette:
1415
- media: "(prefers-color-scheme: light)"
1516
scheme: default
16-
primary: lime
17+
primary: custom
18+
accent: amber
1719
toggle:
1820
icon: material/brightness-7
1921
name: Switch to dark mode
2022

2123
# Palette toggle for dark mode
2224
- media: "(prefers-color-scheme: dark)"
2325
scheme: slate
24-
primary: lime
26+
primary: custom
27+
accent: amber
2528
toggle:
2629
icon: material/brightness-4
2730
name: Switch to light mode
31+
2832
markdown_extensions:
2933
- attr_list
3034
- md_in_html
@@ -40,17 +44,22 @@ plugins:
4044
- glightbox
4145
- search
4246

47+
extra_css:
48+
- stylesheets/extra.css
49+
4350
nav:
4451
- Home: index.md
45-
- Using ZipponDB:
52+
- Features: features.md
53+
- Learn:
4654
- Quickstart: Quickstart.md
4755
- Schema: Schema.md
4856
- ZipponQL: ZiQL.md
4957
- Data types: Data type.md
5058
- Command Line Interface: cli.md
51-
- Under the Hood:
59+
- Technical:
5260
- Benchmark: Benchmark.md
5361
- Technical: Technical docs.md
5462
- ZipponData: ZipponData.md
55-
- About: about.md
56-
- Roadmap: Roadmap.md
63+
- About: about.md
64+
- Roadmap: Roadmap.md
65+
- Release: release.md

0 commit comments

Comments
 (0)