Custom color for docs
This commit is contained in:
parent
425401d764
commit
77e1197894
@ -1,4 +1,4 @@
|
||||

|
||||

|
||||
|
||||
# Introduction
|
||||
|
||||
|
15
docs/Single_file.md
Normal file
15
docs/Single_file.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Single file
|
||||
|
||||
TODO: In the future I will migrate into a single file database like SQLite.
|
||||
|
||||
## FileVar
|
||||
|
||||
A FileVar is a single value but saved in a file. This have a Blok, a position, a size and a type.
|
||||
For string, I will create something different I think, with a size max and a len, and can request more if needed.
|
||||
|
||||
## FileBlok
|
||||
|
||||
A blok is like memory but for file. It has a starting point and a size and can hold entities or FileVar.
|
||||
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.
|
||||
|
||||
In SQLite, it is what they call a page I think. Similare thing.
|
@ -220,6 +220,10 @@ A condition have those infos:
|
||||
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.
|
||||
I transform ConditionValue into Zid Data. Maybe I can directly do a map member name -> zid Data ?
|
||||
|
||||
### RelationMap
|
||||
|
||||
TODO: Explain.
|
||||
|
||||
## EntityWriter
|
||||
|
||||
This is responsable to transform the raw Data into a JSON, Table or other output format to send send to end user.
|
||||
|
3
docs/features.md
Normal file
3
docs/features.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Features
|
||||
|
||||
TODO
|
Binary file not shown.
Before Width: | Height: | Size: 740 KiB |
Binary file not shown.
Before Width: | Height: | Size: 514 KiB After Width: | Height: | Size: 740 KiB |
Binary file not shown.
Before Width: | Height: | Size: 289 KiB |
9
docs/release.md
Normal file
9
docs/release.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Release
|
||||
|
||||
## 0.1.8
|
||||
|
||||
First release.
|
||||
|
||||
Mostly to test the release pipeline with Github actions.
|
||||
Only include CLI, most ZiQL features here but still missing some part.
|
||||
Mostly missing thing around the database to make it usable.
|
12
docs/stylesheets/extra.css
Normal file
12
docs/stylesheets/extra.css
Normal file
@ -0,0 +1,12 @@
|
||||
:root {
|
||||
--md-primary-fg-color: #FEFADF;
|
||||
--md-primary-fg-color--light: #FCFBF2;
|
||||
--md-primary-fg-color--dark: #E3C797;
|
||||
|
||||
--md-primary-bg-color: #000000;
|
||||
--md-typeset-a-color: #000000;
|
||||
}
|
||||
|
||||
[data-md-color-scheme="default"] {
|
||||
--md-typeset-a-color: #c57d00;
|
||||
}
|
21
mkdocs.yml
21
mkdocs.yml
@ -1,3 +1,4 @@
|
||||
site_name: "Documentation"
|
||||
site_url: https://MrBounty.github.io/ZipponDB/
|
||||
repo_url: https://github.com/MrBounty/ZipponDB
|
||||
theme:
|
||||
@ -13,7 +14,8 @@ theme:
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: lime
|
||||
primary: custom
|
||||
accent: amber
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
@ -21,10 +23,12 @@ theme:
|
||||
# Palette toggle for dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: lime
|
||||
primary: custom
|
||||
accent: amber
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- md_in_html
|
||||
@ -40,17 +44,22 @@ plugins:
|
||||
- glightbox
|
||||
- search
|
||||
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Using ZipponDB:
|
||||
- Features: features.md
|
||||
- Learn:
|
||||
- Quickstart: Quickstart.md
|
||||
- Schema: Schema.md
|
||||
- ZipponQL: ZiQL.md
|
||||
- Data types: Data type.md
|
||||
- Command Line Interface: cli.md
|
||||
- Under the Hood:
|
||||
- Technical:
|
||||
- Benchmark: Benchmark.md
|
||||
- Technical: Technical docs.md
|
||||
- ZipponData: ZipponData.md
|
||||
- About: about.md
|
||||
- Roadmap: Roadmap.md
|
||||
- About: about.md
|
||||
- Roadmap: Roadmap.md
|
||||
- Release: release.md
|
||||
|
Loading…
x
Reference in New Issue
Block a user