From 7d6207da0abbfd394f238000308548b0a54f11fa Mon Sep 17 00:00:00 2001 From: oskroblin Skroblin Date: Tue, 5 Mar 2024 10:28:30 +0100 Subject: [PATCH] Started with mkdocs material documentation --- docs/001-index.md | 6 + docs/002-getting-started.md | 4 + docs/003-schema.md | 4 + docs/004-key-value-storage.md | 4 + docs/005-filter-storage.md | 4 + docs/006-aggregation-storage.md | 5 + docs/007-search-storage.md | 7 + docs/foo.md | 247 ++++++++++++++++++++++++++++++++ mkdocs.yml | 47 ++++++ 9 files changed, 328 insertions(+) create mode 100644 docs/001-index.md create mode 100644 docs/002-getting-started.md create mode 100644 docs/003-schema.md create mode 100644 docs/004-key-value-storage.md create mode 100644 docs/005-filter-storage.md create mode 100644 docs/006-aggregation-storage.md create mode 100644 docs/007-search-storage.md create mode 100644 docs/foo.md create mode 100644 mkdocs.yml diff --git a/docs/001-index.md b/docs/001-index.md new file mode 100644 index 0000000..5146e23 --- /dev/null +++ b/docs/001-index.md @@ -0,0 +1,6 @@ +--- +title: Home +icon: material/home +--- + +# Welcome to document storage library diff --git a/docs/002-getting-started.md b/docs/002-getting-started.md new file mode 100644 index 0000000..cbb0d27 --- /dev/null +++ b/docs/002-getting-started.md @@ -0,0 +1,4 @@ +--- +title: Getting started +icon: material/play-circle-outline +--- diff --git a/docs/003-schema.md b/docs/003-schema.md new file mode 100644 index 0000000..e48a393 --- /dev/null +++ b/docs/003-schema.md @@ -0,0 +1,4 @@ +--- +title: Schema +icon: material/file-document-outline +--- diff --git a/docs/004-key-value-storage.md b/docs/004-key-value-storage.md new file mode 100644 index 0000000..166e122 --- /dev/null +++ b/docs/004-key-value-storage.md @@ -0,0 +1,4 @@ +--- +title: Key value +icon: material/key-outline +--- diff --git a/docs/005-filter-storage.md b/docs/005-filter-storage.md new file mode 100644 index 0000000..6d0affa --- /dev/null +++ b/docs/005-filter-storage.md @@ -0,0 +1,4 @@ +--- +title: Filtering +icon: material/filter-outline +--- diff --git a/docs/006-aggregation-storage.md b/docs/006-aggregation-storage.md new file mode 100644 index 0000000..6a6da17 --- /dev/null +++ b/docs/006-aggregation-storage.md @@ -0,0 +1,5 @@ +--- +title: Aggregations +icon: material/format-list-bulleted +--- + diff --git a/docs/007-search-storage.md b/docs/007-search-storage.md new file mode 100644 index 0000000..6254fa5 --- /dev/null +++ b/docs/007-search-storage.md @@ -0,0 +1,7 @@ +--- +title: Full-text search +icon: material/shopping-search-outline +--- + +# Full-text search engines + diff --git a/docs/foo.md b/docs/foo.md new file mode 100644 index 0000000..3f087ca --- /dev/null +++ b/docs/foo.md @@ -0,0 +1,247 @@ +--- +title: Lorem upsum +description: Nullam urna elit, malesuada eget finibus ut, ac tortor. +#icon: material/emoticon-happy +subtitle: Nullam urna elit, malesuada eget finibus ut, ac tortor +#status: new +#status: deprecated +--- + +# Page title + +## Formatting +Text can be {--deleted--} and replacement text {++added++}. This can also be +combined into {~~one~>a single~~} operation. {==Highlighting==} is also +possible {>>and comments can be added inline<<}. + +{== + +Formatting can also be applied to blocks by putting the opening and closing +tags on separate lines and adding new lines between the tags and the content. + +==} + +## Grids + +
+ +- :fontawesome-brands-html5: __HTML__ for content and structure +- :fontawesome-brands-js: __JavaScript__ for interactivity +- :fontawesome-brands-css3: __CSS__ for text running out of boxes +- :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh? + +
+ +--- + +
+ +- :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__ + + --- + + Install [`mkdocs-material`](#) with [`pip`](#) and get up + and running in minutes + + [:octicons-arrow-right-24: Getting started](#) + +- :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__ + + --- + + Focus on your content and generate a responsive and searchable static site + + [:octicons-arrow-right-24: Reference](#) + +- :material-format-font:{ .lg .middle } __Made to measure__ + + --- + + Change the colors, fonts, language, icons, logo and more with a few lines + + [:octicons-arrow-right-24: Customization](#) + +- :material-scale-balance:{ .lg .middle } __Open Source, MIT__ + + --- + + Material for MkDocs is licensed under MIT and available on [GitHub] + + [:octicons-arrow-right-24: License](#) + +
+ +--- + +
+ +:fontawesome-brands-html5: __HTML__ for content and structure +{ .card } + +:fontawesome-brands-js: __JavaScript__ for interactivity +{ .card } + +:fontawesome-brands-css3: __CSS__ for text running out of boxes +{ .card } + +> :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh? + +
+ + +### Tooltip + +[Hover me](https://example.com "I'm a tooltip!") + +[Hover me][example] + +[example]: https://example.com "I'm a tooltip!" + + +:material-information-outline:{ title="Important information" } + +The HTML specification is maintained by the W3C. + +*[HTML]: Hyper Text Markup Language +*[W3C]: World Wide Web Consortium + + +## Lists + +- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit +- [ ] Vestibulum convallis sit amet nisi a tincidunt + * [x] In hac habitasse platea dictumst + * [x] In scelerisque nibh non dolor mollis congue sed et metus + * [ ] Praesent sed risus massa +- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque + +## Footnotes + +Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2] + +[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +[^2]: +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod +nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor +massa, nec semper lorem quam in massa. + +## Code blocks +Nullam urna elit, + +``` php title="create_new_product.py" linenums="1" hl_lines="3 4" +$product = new Product(); + +$product->setName('New product'); +$product->setPrice(100); + +$storage->store($product); +``` + +Nullam urna elit, malesuada eget finibus ut, ac t + + +``` yaml +theme: + features: + - content.code.annotate # (1) +``` + +1. :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted + text__, images, ... basically anything that can be written in Markdown. + + +``` yaml +# (1)! +``` + +1. Look ma, less line noise! + +## Tabs + +=== "C" + + ``` c + #include + + int main(void) { + printf("Hello world!\n"); + return 0; + } + ``` + +=== "C++" + + ``` c++ + #include + + int main(void) { + std::cout << "Hello world!" << std::endl; + return 0; + } + ``` + +### Lists + +=== "Unordered list" + + * Sed sagittis eleifend rutrum + * Donec vitae suscipit est + * Nulla tempor lobortis orci + +=== "Ordered list" + + 1. Sed sagittis eleifend rutrum + 2. Donec vitae suscipit est + 3. Nulla tempor lobortis orci + + +### Embedded + +!!! example + + === "Unordered List" + + ``` markdown + * Sed sagittis eleifend rutrum + * Donec vitae suscipit est + * Nulla tempor lobortis orci + ``` + + === "Ordered List" + + ``` markdown + 1. Sed sagittis eleifend rutrum + 2. Donec vitae suscipit est + 3. Nulla tempor lobortis orci + ``` + +## Admonitions + +!!! note + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + + +!!! note "Phasellus posuere in sem ut cursus" + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + +??? note + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + +## Data tables + +| Method | Description | +| ----------- | ------------------------------------ | +| `GET` | :material-check: Fetch resource | +| `PUT` | :material-check-all: Update resource | +| `DELETE` | :material-close: Delete resource | + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..bfa9e7d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,47 @@ +site_name: Document storages +theme: + name: material + features: + - content.code.copy + - content.code.select + - content.code.annotate + - content.tabs.link + - content.tooltips + - navigation.tracking + - navigation.instant.preview + - navigation.sections +extra: + status: + : + annotate: + json: [.s2] +markdown_extensions: + - admonition + - pymdownx.details + - footnotes + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + slugify: !!python/object/apply:pymdownx.slugs.slugify + kwds: + case: lower + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - attr_list + - md_in_html + - def_list + - abbr + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg \ No newline at end of file