From e0977c983abff89ac3a9e37f616399dc0b6c61c7 Mon Sep 17 00:00:00 2001 From: sptaule Date: Wed, 26 Jan 2022 14:44:47 +0100 Subject: Fix doc links & added noJS support for the doc --- config.toml | 8 +- content/_img/endpoint-latency-dc.png | Bin 0 -> 131776 bytes content/_img/endpoint-latency.png | Bin 0 -> 127369 bytes content/blog/post-0.md | 238 +++++++++++++++----- content/blog/post-1.md | 4 - content/blog/post-2.md | 4 - content/blog/post-3.md | 4 - content/blog/post-4.md | 4 - content/blog/post-5.md | 4 - content/blog/post-6.md | 4 - content/blog/post-7.md | 4 - content/documentation/connect/apps.md | 4 +- .../documentation/connect/cli-nextcloud-gui.png | Bin 0 -> 201685 bytes content/documentation/connect/fs.md | 2 +- content/documentation/connect/repositories.md | 4 +- content/documentation/connect/websites.md | 4 +- .../documentation/cookbook/exposing_websites.md | 8 +- content/documentation/cookbook/real_world.md | 10 +- content/documentation/cookbook/reverse_proxy.md | 2 +- content/documentation/design/benchmarks.md | 4 +- .../documentation/design/endpoint-latency-dc.png | Bin 0 -> 131776 bytes content/documentation/design/endpoint-latency.png | Bin 0 -> 127369 bytes .../design/img/endpoint-latency-dc.png | Bin 131776 -> 0 bytes .../documentation/design/img/endpoint-latency.png | Bin 127369 -> 0 bytes content/documentation/development/scripts.md | 6 +- content/documentation/quick-start/overview.md | 6 +- .../reference-manual/configuration.md | 2 +- content/documentation/reference-manual/layout.md | 2 +- src/input.css | 32 ++- static/js/site.js | 161 +------------- templates/base.html | 11 +- templates/categories/list.html | 27 --- templates/categories/single.html | 76 ------- templates/documentation.html | 245 +++------------------ templates/index.html | 48 ++-- templates/page.html | 4 +- templates/partials/doc/global_toc.html | 34 +++ templates/partials/doc/page_toc.html | 33 +++ templates/partials/doc/pagination.html | 76 +++++++ templates/partials/doc/toc_script.html | 55 +++++ templates/tags/list.html | 27 --- templates/tags/single.html | 76 ------- 42 files changed, 512 insertions(+), 721 deletions(-) create mode 100644 content/_img/endpoint-latency-dc.png create mode 100644 content/_img/endpoint-latency.png create mode 100644 content/documentation/connect/cli-nextcloud-gui.png create mode 100644 content/documentation/design/endpoint-latency-dc.png create mode 100644 content/documentation/design/endpoint-latency.png delete mode 100644 content/documentation/design/img/endpoint-latency-dc.png delete mode 100644 content/documentation/design/img/endpoint-latency.png delete mode 100755 templates/categories/list.html delete mode 100755 templates/categories/single.html create mode 100644 templates/partials/doc/global_toc.html create mode 100644 templates/partials/doc/page_toc.html create mode 100644 templates/partials/doc/pagination.html create mode 100644 templates/partials/doc/toc_script.html delete mode 100755 templates/tags/list.html delete mode 100755 templates/tags/single.html diff --git a/config.toml b/config.toml index 5992b61..3a90373 100755 --- a/config.toml +++ b/config.toml @@ -9,10 +9,10 @@ ignored_content = [] generate_feed = true feed_filename = "rss.xml" hard_link_static = false -taxonomies = [ - { name = "categories", feed = true, paginate_by = 10 }, - { name = "tags", feed = true, paginate_by = 10 } -] +# taxonomies = [ +# { name = "categories", feed = true, paginate_by = 10 }, +# { name = "tags", feed = true, paginate_by = 10 } +# ] build_search_index = true [markdown] diff --git a/content/_img/endpoint-latency-dc.png b/content/_img/endpoint-latency-dc.png new file mode 100644 index 0000000..7c7411c Binary files /dev/null and b/content/_img/endpoint-latency-dc.png differ diff --git a/content/_img/endpoint-latency.png b/content/_img/endpoint-latency.png new file mode 100644 index 0000000..741539a Binary files /dev/null and b/content/_img/endpoint-latency.png differ diff --git a/content/blog/post-0.md b/content/blog/post-0.md index 69643f1..b79aabe 100755 --- a/content/blog/post-0.md +++ b/content/blog/post-0.md @@ -1,10 +1,6 @@ +++ title="Zeroth Post" date=2018-08-20 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ @@ -12,99 +8,231 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +--- +__Advertisement :)__ -# A Really Clever Title -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +- __[pica](https://nodeca.github.io/pica/demo/)__ - high quality and fast image + resize in browser. +- __[babelfish](https://github.com/nodeca/babelfish/)__ - developer friendly + i18n with plurals support and easy syntax. -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +You will like those projects! -## A Really Clever Subtitle -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +--- -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +# h1 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +## h2 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +### h3 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +#### h4 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +##### h5 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +###### h6 Heading +Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +## Horizontal Rules -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +## Typographic replacements -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. +Enable typographer option to see result. -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +(c) (C) (r) (R) (tm) (TM) (p) (P) +- -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. +test.. test... test..... test?..... test!.... -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +!!!!!! ???? ,, -- --- -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +"Smartypants, double quotes" and 'single quotes' -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +## Emphasis -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +**This is bold text** -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +__This is bold text__ -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. +*This is italic text* -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +_This is italic text_ -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +~~Strikethrough~~ -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. +## Blockquotes -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. +> I +>> Fart +>>> On +>>>> People -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +## Lists -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +Unordered -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. ++ Create a list by starting a line with `+`, `-`, or `*` ++ Sub-lists are made by indenting 2 spaces: + - Marker character change forces new list start: + * Ac tristique libero volutpat at + + Facilisis in pretium nisl aliquet + - Nulla volutpat aliquam velit ++ Very easy! -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +1. You can use sequential numbers... +1. ...or keep all the numbers as `1.` -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. +Start numbering with offset: -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +57. foo +1. bar -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +## Code -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. +Inline `code` -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. +--- -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +Block code "fences" +``` +Sample text here... +``` +--- +Syntax highlighting -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla ac iaculis libero. Suspendisse et sodales tellus, ut sodales mi. Proin scelerisque est nec laoreet aliquet. Aenean et nunc at mi efficitur sollicitudin at quis diam. Aenean mi massa, sollicitudin eu condimentum sed, sodales ut nisi. Aenean iaculis ante id gravida hendrerit. Nulla nisi neque, facilisis vitae viverra ac, interdum malesuada quam. Quisque laoreet leo nec lectus lacinia, in lacinia enim tempor. +``` js +var foo = function (bar) { + return bar++; +}; + +console.log(foo(5)); +``` + +## Tables + +| Option | Description | +| ------ | ----------- | +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | + +## Links + +[link text](http://dev.nodeca.com) + +[link with title](http://nodeca.github.io/pica/demo/ "title text!") + +## Images + +![Minion](https://octodex.github.com/images/minion.png) +![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") + +Like links, Images also have a footnote style syntax + +![Alt text][id] + +With a reference later in the document defining the URL location: + +[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" + + +## Plugins + +The killer feature of `markdown-it` is very effective support of +[syntax plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin). + + +### [Emojies](https://github.com/markdown-it/markdown-it-emoji) + +> Classic markup: :wink: :cry: :laughing: :yum: + + +### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup) + +$$\begin{array}{c} + +\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} & += \frac{4\pi}{c}\vec{\mathbf{j}} \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\ + +\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\ + +\nabla \cdot \vec{\mathbf{B}} & = 0 + +\end{array}$$ + + +### [\](https://github.com/markdown-it/markdown-it-ins) + +++Inserted text++ + + +### [\](https://github.com/markdown-it/markdown-it-mark) + +==Marked text== + + +### [Footnotes](https://github.com/markdown-it/markdown-it-footnote) + +Footnote 1 link[^first]. + +Footnote 2 link[^second]. + +Inline footnote^[Text of inline footnote] definition. + +Duplicated footnote reference[^second]. + +[^first]: Footnote **can have markup** + + and multiple paragraphs. + +[^second]: Footnote text. + + +### [Definition lists](https://github.com/markdown-it/markdown-it-deflist) + +Term 1 + +: Definition 1 +with lazy continuation. + +Term 2 with *inline markup* + +: Definition 2 + + { some code, part of Definition 2 } + + Third paragraph of definition 2. + +_Compact style:_ + +Term 1 + ~ Definition 1 + +Term 2 + ~ Definition 2a + ~ Definition 2b + + +### [Abbreviations](https://github.com/markdown-it/markdown-it-abbr) + +This is HTML abbreviation example. -Nulla facilisi. Aenean urna metus, egestas quis mauris non, dignissim vestibulum risus. Mauris posuere nisl a massa commodo rhoncus. Fusce sed euismod dui, eget aliquet sem. Aenean quam est, iaculis quis aliquet at, semper id tellus. Suspendisse fringilla ipsum diam, suscipit commodo neque varius ac. Maecenas commodo orci vitae massa dapibus, interdum ultricies ex scelerisque. Nullam volutpat mollis aliquam. Donec fringilla interdum urna, nec posuere est tincidunt a. +It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on. -Morbi molestie aliquam congue. Sed pulvinar id lectus eget luctus. Fusce non augue efficitur, posuere dolor et, gravida enim. In ullamcorper lorem turpis, in finibus eros posuere id. Maecenas vulputate dapibus risus vel tempor. In pulvinar commodo dui eu mattis. Duis fringilla dictum elit, et dictum nisi sollicitudin non. Vestibulum fermentum ligula id augue ullamcorper, a bibendum neque ultrices. +*[HTML]: Hyper Text Markup Language -Vivamus at volutpat dolor, vitae interdum nulla. Morbi vitae sagittis mi, a pulvinar ex. Fusce convallis diam quis turpis tristique, sodales euismod nunc ullamcorper. Aenean id nulla et leo sodales aliquam. Donec a felis vel ipsum fringilla volutpat. Praesent luctus nisl sit amet est interdum elementum. Etiam tincidunt malesuada sapien, quis tincidunt urna faucibus sed. Aliquam iaculis ex at felis sodales iaculis. Sed quis mauris finibus, consequat risus rutrum, ornare libero. Maecenas ultrices mollis nibh in interdum. Cras molestie quis velit quis dictum. Cras vehicula neque id turpis facilisis fringilla. Quisque sit amet tincidunt lectus, vel feugiat diam. Nullam euismod lacinia mi non facilisis. +### [Custom containers](https://github.com/markdown-it/markdown-it-container) -Sed tempus odio vel tellus tempor laoreet. Sed finibus nulla quis velit molestie dictum. Donec efficitur sollicitudin enim in vestibulum. Etiam porta urna ut nisl scelerisque sagittis. Quisque turpis neque, vulputate nec dui ornare, dignissim aliquet mi. Proin vel scelerisque tellus. Nunc laoreet rutrum luctus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Etiam quis diam tellus. +::: warning +*here be dragons* +::: \ No newline at end of file diff --git a/content/blog/post-1.md b/content/blog/post-1.md index 8f9373b..178dfe8 100755 --- a/content/blog/post-1.md +++ b/content/blog/post-1.md @@ -1,10 +1,6 @@ +++ title="First Post" date=2018-08-21 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-2.md b/content/blog/post-2.md index 49d95c6..c01d95b 100755 --- a/content/blog/post-2.md +++ b/content/blog/post-2.md @@ -1,10 +1,6 @@ +++ title="Second Post" date=2018-08-22 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-3.md b/content/blog/post-3.md index 003dbc8..cc61265 100755 --- a/content/blog/post-3.md +++ b/content/blog/post-3.md @@ -1,10 +1,6 @@ +++ title="Third Post" date=2018-09-23 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-4.md b/content/blog/post-4.md index c4d5aaa..aea482d 100755 --- a/content/blog/post-4.md +++ b/content/blog/post-4.md @@ -1,10 +1,6 @@ +++ title="Fourth Post" date=2018-09-24 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-5.md b/content/blog/post-5.md index e342d30..be93c34 100755 --- a/content/blog/post-5.md +++ b/content/blog/post-5.md @@ -1,10 +1,6 @@ +++ title="Fifth Post" date=2019-01-25 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-6.md b/content/blog/post-6.md index 1a00325..e71bb97 100755 --- a/content/blog/post-6.md +++ b/content/blog/post-6.md @@ -1,10 +1,6 @@ +++ title="Sixth Post" date=2019-02-26 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/blog/post-7.md b/content/blog/post-7.md index 2a9252c..950ae1b 100755 --- a/content/blog/post-7.md +++ b/content/blog/post-7.md @@ -1,10 +1,6 @@ +++ title="Seventh Post" date=2019-03-27 - -[taxonomies] -categories = ["Sample Post"] -tags = ["post", "lorem"] +++ diff --git a/content/documentation/connect/apps.md b/content/documentation/connect/apps.md index 37e57f3..82af8a6 100644 --- a/content/documentation/connect/apps.md +++ b/content/documentation/connect/apps.md @@ -71,7 +71,7 @@ To test your new configuration, just reload your Nextcloud webpage and start sen **From the GUI.** Activate the "External storage support" app from the "Applications" page (click on your account icon on the top right corner of your screen to display the menu). Go to your parameters page (also located below your account icon). Click on external storage (or the corresponding translation in your language). -[![Screenshot of the External Storage form](./cli-nextcloud-gui.png)](./cli-nextcloud-gui.png) +[![Screenshot of the External Storage form](../cli-nextcloud-gui.png)](../cli-nextcloud-gui.png) *Click on the picture to zoom* Add a new external storage. Put what you want in "folder name" (eg. "shared"). Select "Amazon S3". Keep "Access Key" for the Authentication field. @@ -258,7 +258,7 @@ Make sure you (will) have a corresponding DNS entry for them. Now we will configure a reverse proxy in front of Garage. This is required as we have no other way to serve CORS headers yet. -Check the [Configuring a reverse proxy](/cookbook/reverse_proxy.html) section to know how. +Check the [Configuring a reverse proxy](/documentation/cookbook/reverse-proxy/) section to know how. Now make sure that your 2 dns entries are pointing to your reverse proxy. diff --git a/content/documentation/connect/cli-nextcloud-gui.png b/content/documentation/connect/cli-nextcloud-gui.png new file mode 100644 index 0000000..7a58a3a Binary files /dev/null and b/content/documentation/connect/cli-nextcloud-gui.png differ diff --git a/content/documentation/connect/fs.md b/content/documentation/connect/fs.md index eb1405f..7f10b60 100644 --- a/content/documentation/connect/fs.md +++ b/content/documentation/connect/fs.md @@ -16,7 +16,7 @@ Ideally, avoid these solutions at all for any serious or production use. ## rclone mount -rclone uses the same configuration when used [in CLI](/connect/cli.html) and mount mode. +rclone uses the same configuration when used [in CLI](/documentation/connect/cli/) and mount mode. We suppose you have the following entry in your `rclone.ini` (mine is located in `~/.config/rclone/rclone.conf`): ```toml diff --git a/content/documentation/connect/repositories.md b/content/documentation/connect/repositories.md index 52d27f3..53e3a51 100644 --- a/content/documentation/connect/repositories.md +++ b/content/documentation/connect/repositories.md @@ -94,8 +94,8 @@ garage bucket website nix.example.com --allow ``` If you need more information about exposing buckets as websites on Garage, -check [Exposing buckets as websites](/cookbook/exposing_websites.html) - and [Configuring a reverse proxy](/cookbook/reverse_proxy.html). +check [Exposing buckets as websites](/documentation/cookbook/exposing-websites/) + and [Configuring a reverse proxy](/documentation/cookbook/reverse-proxy/). Next, we want to check that our bucket works: diff --git a/content/documentation/connect/websites.md b/content/documentation/connect/websites.md index 1dd9170..6710e91 100644 --- a/content/documentation/connect/websites.md +++ b/content/documentation/connect/websites.md @@ -55,7 +55,7 @@ Currently, the proposed workaround is to deploy your website manually: - Click on Get website files - You need to synchronize the output folder you see in your file explorer, we will use minio client. -Be sure that you [configured minio client](cli.html#minio-client-recommended). +Be sure that you [configured minio client](/documentation/connect/cli/#minio-client-recommended). Then copy this output folder @@ -68,7 +68,7 @@ mc mirror --overwrite output garage/my-site Some tools do not support sending to a S3 backend but output a compiled folder on your system. We can then use any CLI tool to upload this content to our S3 target. -First, start by [configuring minio client](cli.html#minio-client-recommended). +First, start by [configuring minio client](/documentation/connect/cli/#minio-client-recommended). Then build your website: diff --git a/content/documentation/cookbook/exposing_websites.md b/content/documentation/cookbook/exposing_websites.md index e592e6c..91ade7d 100644 --- a/content/documentation/cookbook/exposing_websites.md +++ b/content/documentation/cookbook/exposing_websites.md @@ -16,11 +16,11 @@ Now it will be **publicly** exposed on the web endpoint (by default listening on Our website serving logic is as follow: - Supports only static websites (no support for PHP or other languages) - Does not support directory listing - - The index is defined in your `garage.toml`. ([ref](/reference_manual/configuration.html#index)) + - The index is defined in your `garage.toml`. ([ref](/documentation/reference-manual/configuration/#garage-configuration-file-format-reference)) Now we need to infer the URL of your website through your bucket name. Let assume: - - we set `root_domain = ".web.example.com"` in `garage.toml` ([ref](/reference_manual/configuration.html#root_domain)) + - we set `root_domain = ".web.example.com"` in `garage.toml` ([ref](/documentation/reference-manual/configuration/#garage-configuration-file-format-reference)) - our bucket name is `garagehq.deuxfleurs.fr`. Our bucket will be served if the Host field matches one of these 2 values (the port is ignored): @@ -48,6 +48,6 @@ Now that you understand how website logic works on Garage, you can: - make the website endpoint listens on port 80 (instead of 3902) - use iptables to redirect the port 80 to the port 3902: `iptables -t nat -A PREROUTING -p tcp -dport 80 -j REDIRECT -to-port 3902` - - or configure a [reverse proxy](reverse_proxy.html) in front of Garage to add TLS (HTTPS), CORS support, etc. + - or configure a [reverse proxy](/documentation/cookbook/reverse-proxy/) in front of Garage to add TLS (HTTPS), CORS support, etc. -You can also take a look at [Website Integration](/connect/websites.html) to see how you can add Garage to your workflow. +You can also take a look at [Website Integration](/documentation/connect/websites/) to see how you can add Garage to your workflow. diff --git a/content/documentation/cookbook/real_world.md b/content/documentation/cookbook/real_world.md index 049a54a..a010d29 100644 --- a/content/documentation/cookbook/real_world.md +++ b/content/documentation/cookbook/real_world.md @@ -9,7 +9,7 @@ To run Garage in cluster mode, we recommend having at least 3 nodes. This will allow you to setup Garage for three-way replication of your data, the safest and most available mode proposed by Garage. -We recommend first following the [quick start guide](../quick_start/index.md) in order +We recommend first following the [quick start guide](/documentation/quick-start/) in order to get familiar with Garage's command line and usage patterns. @@ -28,7 +28,7 @@ To run a real-world deployment, make sure the following conditions are met: to drastically reduce Garage's response times. - This guide will assume you are using Docker containers to deploy Garage on each node. - Garage can also be run independently, for instance as a [Systemd service](systemd.md). + Garage can also be run independently, for instance as a [Systemd service](/documentation/cookbook/systemd/). You can also use an orchestrator such as Nomad or Kubernetes to automatically manage Docker containers on a fleet of nodes. @@ -283,15 +283,15 @@ garage layout apply ``` **WARNING:** if you want to use the layout modification commands in a script, -make sure to read [this page](/reference_manual/layout.html) first. +make sure to read [this page](/documentation/reference-manual/) first. ## Using your Garage cluster Creating buckets and managing keys is done using the `garage` CLI, -and is covered in the [quick start guide](../quick_start/index.md). +and is covered in the [quick start guide](/documentation/quick-start/). Remember also that the CLI is self-documented thanks to the `--help` flag and the `help` subcommand (e.g. `garage help`, `garage key --help`). Configuring S3-compatible applicatiosn to interact with Garage -is covered in the [Integrations](/connect/index.html) section. +is covered in the [Integrations](/documentation/connect/) section. diff --git a/content/documentation/cookbook/reverse_proxy.md b/content/documentation/cookbook/reverse_proxy.md index 36b9ea3..7fca5e6 100644 --- a/content/documentation/cookbook/reverse_proxy.md +++ b/content/documentation/cookbook/reverse_proxy.md @@ -123,7 +123,7 @@ server { ### Exposing the web endpoint The web endpoint is a bit more complicated to configure as it listens on many different `Host` fields. -To better understand the logic involved, you can refer to the [Exposing buckets as websites](/cookbook/exposing_websites.html) section. +To better understand the logic involved, you can refer to the [Exposing buckets as websites](/documentation/cookbook/exposing-websites/) section. Also, for some applications, you may need to serve CORS headers: Garage can not serve them directly but we show how we can use nginx to serve them. You can use the following example as your starting point: diff --git a/content/documentation/design/benchmarks.md b/content/documentation/design/benchmarks.md index 7829de4..62e8480 100644 --- a/content/documentation/design/benchmarks.md +++ b/content/documentation/design/benchmarks.md @@ -30,7 +30,7 @@ We selected 5 standard endpoints that are often in the critical path: ListBucket In this first benchmark, we consider 5 instances that are located in a different place each. To simulate the distance, we configure mknet with a RTT between each node of 100 ms +/- 20 ms of jitter. We get the following graph, where the colored bars represent the mean latency while the error bars the minimum and maximum one: -![Comparison of endpoints latency for minio and garage](./img/endpoint-latency.png) +![Comparison of endpoints latency for minio and garage](../endpoint-latency.png) Compared to garage, minio latency drastically increases on 3 endpoints: GetObject, PutObject, RemoveObject. @@ -48,7 +48,7 @@ We consider that intra-DC communications are now very cheap with a latency of 0. The inter-DC remains costly with the same value as before (100ms +/- 20ms of jitter). We plot a similar graph as before: -![Comparison of endpoints latency for minio and garage with 6 nodes in 3 DC](./img/endpoint-latency-dc.png) +![Comparison of endpoints latency for minio and garage with 6 nodes in 3 DC](../endpoint-latency-dc.png) This new graph is very similar to the one before, neither minio or garage seems to benefit from this new topology, but they also do not suffer from it. diff --git a/content/documentation/design/endpoint-latency-dc.png b/content/documentation/design/endpoint-latency-dc.png new file mode 100644 index 0000000..7c7411c Binary files /dev/null and b/content/documentation/design/endpoint-latency-dc.png differ diff --git a/content/documentation/design/endpoint-latency.png b/content/documentation/design/endpoint-latency.png new file mode 100644 index 0000000..741539a Binary files /dev/null and b/content/documentation/design/endpoint-latency.png differ diff --git a/content/documentation/design/img/endpoint-latency-dc.png b/content/documentation/design/img/endpoint-latency-dc.png deleted file mode 100644 index 7c7411c..0000000 Binary files a/content/documentation/design/img/endpoint-latency-dc.png and /dev/null differ diff --git a/content/documentation/design/img/endpoint-latency.png b/content/documentation/design/img/endpoint-latency.png deleted file mode 100644 index 741539a..0000000 Binary files a/content/documentation/design/img/endpoint-latency.png and /dev/null differ diff --git a/content/documentation/development/scripts.md b/content/documentation/development/scripts.md index a6db23c..a3871eb 100644 --- a/content/documentation/development/scripts.md +++ b/content/documentation/development/scripts.md @@ -36,7 +36,7 @@ You can inspect the detailed configuration, including ports, by inspecting `/tmp This script also spawns a simple HTTPS reverse proxy through `socat` for the S3 endpoint that listens on port `4443`. Some libraries might require a TLS endpoint to work, refer to our issue [#64](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/64) for more detailed information on this subject. -This script covers the [Launching the garage server](/quick_start/index.html#launching-the-garage-server) section of our Quick start page. +This script covers the [Launching the garage server](/documentation/quick-start/overview/#launching-the-garage-server) section of our Quick start page. ### 2. Make them join the cluster @@ -46,7 +46,7 @@ This script covers the [Launching the garage server](/quick_start/index.html#lau This script will configure each instance by assigning them a zone (`dc1`) and a weight (`1`). -This script covers the [Configuring your Garage node](/quick_start/index.html#configuring-your-garage-node) section of our Quick start page. +This script covers the [Configuring your Garage node](/documentation/quick-start/overview/) section of our Quick start page. ### 3. Create a key and a bucket @@ -57,7 +57,7 @@ This script covers the [Configuring your Garage node](/quick_start/index.html#co This script will create a bucket named `eprouvette` with a key having read and write rights on this bucket. The key is stored in a filed named `/tmp/garage.s3` and can be used by the following tools to pre-configure them. -This script covers the [Creating buckets and keys](/quick_start/index.html#creating-buckets-and-keys) section of our Quick start page. +This script covers the [Creating buckets and keys](/documentation/quick-start/overview/#creating-buckets-and-keys) section of our Quick start page. ## Handlers for generic tools diff --git a/content/documentation/quick-start/overview.md b/content/documentation/quick-start/overview.md index f09d748..478e033 100644 --- a/content/documentation/quick-start/overview.md +++ b/content/documentation/quick-start/overview.md @@ -11,7 +11,7 @@ and how to interact with it. Our goal is to introduce you to Garage's workflows. Following this guide is recommended before moving on to -[configuring a multi-node cluster](../cookbook/real_world.md). +[configuring a multi-node cluster](/documentation/cookbook/real-world/). Note that this kind of deployment should not be used in production, as it provides no redundancy for your data! @@ -28,7 +28,7 @@ or in `~/.local/bin`). If a binary of the last version is not available for your architecture, or if you want a build customized for your system, -you can [build Garage from source](../cookbook/from_source.md). +you can [build Garage from source](/documentation/cookbook/from-source/). ## Writing a first configuration file @@ -280,5 +280,5 @@ The following tools can also be used to send and recieve files from/to Garage: - [Cyberduck](https://cyberduck.io/) - [`s3cmd`](https://s3tools.org/s3cmd) -Refer to the ["Integrations" section](../connect/index.md) to learn how to +Refer to the ["Integrations" section](/documentation/connect/) to learn how to configure application and command line utilities to integrate with Garage. diff --git a/content/documentation/reference-manual/configuration.md b/content/documentation/reference-manual/configuration.md index c9ebee2..1b3782c 100644 --- a/content/documentation/reference-manual/configuration.md +++ b/content/documentation/reference-manual/configuration.md @@ -62,7 +62,7 @@ Store this folder on a fast SSD drive if possible to maximize Garage's performan The directory in which Garage will store the data blocks of objects. This folder can be placed on an HDD. The space available for `data_dir` should be counted to determine a node's capacity -when [configuring it](../getting_started/05_cluster.md). +when [configuring it](/documentation/reference-manual/layout/). #### `block_size` diff --git a/content/documentation/reference-manual/layout.md b/content/documentation/reference-manual/layout.md index 32706d0..79afccf 100644 --- a/content/documentation/reference-manual/layout.md +++ b/content/documentation/reference-manual/layout.md @@ -9,7 +9,7 @@ The cluster layout in Garage is a table that assigns to each node a role in the cluster. The role of a node in Garage can either be a storage node with a certain capacity, or a gateway node that does not store data and is only used as an API entry point for faster cluster access. -An introduction to building cluster layouts can be found in the [production deployment](/cookbook/real_world.md) page. +An introduction to building cluster layouts can be found in the [production deployment](/documentation/cookbook/real-world/) page. ## How cluster layouts work in Garage diff --git a/src/input.css b/src/input.css index ba1be60..1a5d06b 100755 --- a/src/input.css +++ b/src/input.css @@ -4,6 +4,10 @@ /* ARTICLES BASIC ELEMENTS */ +article .page-content { + @apply text-lg; +} + /** Pre */ article pre { @@ -66,8 +70,8 @@ article ol ul { @apply ml-4 py-0 list-disc; } -p > code { - @apply bg-gray-100 p-1 rounded font-semibold text-garage-gray shadow-inner; +p > code, p > strong > code, li > code, li > strong > code { + @apply bg-gray-100 text-base py-0.5 px-1 rounded font-semibold text-garage-gray shadow-inner; } .page-content > h1 { @@ -87,9 +91,31 @@ p > code { } .page-content a { - @apply font-semibold text-garage-orange border-b hover:border-garage-gray px-0.5 border-garage-orange bg-transparent hover:bg-garage-orange hover:text-white hover:rounded-sm hover:no-underline duration-150 transition; + @apply font-semibold text-garage-orange border-b hover:border-garage-gray border-garage-orange bg-transparent hover:bg-garage-orange hover:text-white hover:rounded-sm hover:no-underline duration-150 transition; +} + +.page-content img { + @apply inline-block my-8 shadow rounded; } .is-active { @apply text-orange-600; } + +@layer utilities { + + /** Global ToC */ + #global_toc .deploySubMenu { + position: absolute; + left: -100vw; + } + + #global_toc .deploySubMenu:checked ~ .subMenu { + display: none; + } + + #global_toc .deploySubMenu:checked + label .arrow { + transform: rotate(0deg); + } + +} \ No newline at end of file diff --git a/static/js/site.js b/static/js/site.js index ab6b766..4b64425 100755 --- a/static/js/site.js +++ b/static/js/site.js @@ -168,163 +168,4 @@ function search() { } }, 150) ); -} - -function documentReadyCallback() { - - if (localStorage.getItem("theme") === "dark") { - document.body.setAttribute("theme", "dark"); - document.querySelectorAll("img, picture, video, pre").forEach(img => img.setAttribute("theme", "dark")); - document.querySelectorAll(".vimeo, .youtube, .chart").forEach(video => video.setAttribute("theme", "dark")); - document.getElementById("dark-mode").setAttribute("title", "Switch to light theme"); - } - - document.querySelector(".navbar-burger").addEventListener("click", () => { - document.querySelector(".navbar-burger").classList.toggle("is-active"); - document.querySelector(".navbar-menu").classList.toggle("is-active"); - }); - - document.querySelectorAll("div.navbar-end > .navbar-item").forEach((el) => { - if (location.href.includes(el.getAttribute("href"))) { - document.querySelectorAll("a.navbar-item.is-active").forEach(itm => itm.classList.remove("is-active")); - el.classList.add("is-active"); - } - }) - - document.getElementById("nav-search").addEventListener("click", (evt) => { - //let target = evt.currentTarget.getAttribute("data-target"); - document.querySelector("html").classList.add("is-clipped"); - document.getElementById("search-modal").classList.add("is-active"); - - document.getElementById("search").focus(); - document.getElementById("search").select(); - }); - - document.querySelector(".modal-close").addEventListener("click", (evt) => { - document.querySelector("html").classList.remove("is-clipped"); - evt.currentTarget.parentElement.classList.remove("is-active"); - }); - - document.querySelector(".modal-background").addEventListener("click", (evt) => { - document.querySelector("html").classList.remove("is-clipped"); - evt.currentTarget.parentElement.classList.remove("is-active"); - }); - - document.getElementById("search").addEventListener("keyup", () => { - search(); - }); - - document.getElementById("dark-mode").addEventListener("click", () => { - if ( - localStorage.getItem("theme") == null || - localStorage.getItem("theme") == "light" - ) { - localStorage.setItem("theme", "dark"); - document.body.setAttribute("theme", "dark"); - document.querySelectorAll("img, picture, video, pre").forEach(img => img.setAttribute("theme", "dark")); - document.querySelectorAll(".vimeo, .youtube, .chart").forEach(video => video.setAttribute("theme", "dark")); - - document.getElementById("dark-mode").setAttribute("title", "Switch to light theme"); - } else { - localStorage.setItem("theme", "light"); - document.body.removeAttribute("theme", "dark"); - document.querySelectorAll("img, picture, video, pre").forEach(img => img.removeAttribute("theme", "dark")) - document.querySelectorAll(".vimeo, .youtube, .chart").forEach(video => video.removeAttribute("theme", "dark")); - - document.getElementById("dark-mode").setAttribute("title", "Switch to dark theme"); - } - }); - - if (typeof mermaid !== "undefined") { - mermaid.initialize({ startOnLoad: true }); - } - - if (typeof chartXkcd !== "undefined") { - document.querySelectorAll(".chart").forEach((el, i) => { - el.setAttribute("id", `chart-${i}`); - - let svg = document.getElementById(`chart-${i}`); - let { type, ...chartData } = JSON.parse(el.textContent); - new chartXkcd[type](svg, chartData); - }); - } - - if (typeof Galleria !== "undefined") { - document.querySelectorAll(".galleria").forEach((el, i) => { - el.setAttribute("id", `galleria-${i}`); - - let { images } = JSON.parse(el.textContent); - - for (let image of images) { - el.insertAdjacentHTML("beforeend", - `` - ); - } - - Galleria.run(".galleria"); - }); - } - - if (typeof mapboxgl !== "undefined") { - document.querySelectorAll(".map").forEach((el, i) => { - el.setAttribute("id", `map-${i}`); - - mapboxgl.accessToken = el.querySelector(".mapbox-access-token").textContent.trim(); - let zoom = el.querySelector(".mapbox-zoom").textContent.trim(); - - let map = new mapboxgl.Map({ - container: `map-${i}`, - style: "mapbox://styles/mapbox/light-v10", - center: [-96, 37.8], - zoom: zoom, - }); - - map.addControl(new mapboxgl.NavigationControl()); - - let geojson = JSON.parse(el.querySelector(".mapbox-geojson").textContent.trim()); - - const center = [0, 0]; - - geojson.features.forEach(function (marker) { - center[0] += marker.geometry.coordinates[0]; - center[1] += marker.geometry.coordinates[1]; - - new mapboxgl.Marker() - .setLngLat(marker.geometry.coordinates) - .setPopup( - new mapboxgl.Popup({ offset: 25 }) // add popups - .setHTML( - "

" + - marker.properties.title + - "

" + - marker.properties.description + - "

" - ) - ) - .addTo(map); - }); - - center[0] = center[0] / geojson.features.length; - center[1] = center[1] / geojson.features.length; - - map.setCenter(center); - }); - } - - if (typeof renderMathInElement !== "undefined") { - renderMathInElement(document.body, { - delimiters: [ - { left: '$$', right: '$$', display: true }, - { left: '$', right: '$', display: false }, - { left: '\\(', right: '\\)', display: false }, - { left: '\\[', right: '\\]', display: true } - ] - }); - } -}; - -if (document.readyState === 'loading') { // Loading hasn't finished yet - document.addEventListener('DOMContentLoaded', documentReadyCallback); -} else { // `DOMContentLoaded` has already fired - documentReadyCallback(); -} +} \ No newline at end of file diff --git a/templates/base.html b/templates/base.html index b6c8760..bdda7e4 100755 --- a/templates/base.html +++ b/templates/base.html @@ -83,10 +83,13 @@ {% endfor %}
- - - - + + + + +
+
+ {{ macros:: social_links( social_config=config.extra.social) }}
diff --git a/templates/categories/list.html b/templates/categories/list.html deleted file mode 100755 index c78c7b0..0000000 --- a/templates/categories/list.html +++ /dev/null @@ -1,27 +0,0 @@ -{% extends "base.html" %} - -{% block content %} -
-
-
-

- - - - Categories -

-

{{ terms | length }} categories in total

-

- {% for category in terms %} - - - - - {{category.name}} {{ category.pages | length }} - - {% endfor %} -

-
-
-
-{% endblock content %} diff --git a/templates/categories/single.html b/templates/categories/single.html deleted file mode 100755 index a3d2159..0000000 --- a/templates/categories/single.html +++ /dev/null @@ -1,76 +0,0 @@ -{% extends "base.html" %} - -{% block header %} -
-
-
-
-

- - - - - {{ term.name }} - -

-
-
-
-
-{% endblock %} - -{% block content %} -
-
-
-
- {% if paginator %} - {% set pages = paginator.pages %} - {% else %} - {% set pages = term.pages %} - {% endif %} - - {% for page in pages %} -
-

- - {{ page.title }} - -

-

{{ page.description }}

-
-
- {{ macros::page_publish_metadata(page=page) }} -
-
- {{ macros::page_content_metadata(page=page) }} -
-
-
- {{ page.summary | safe }} - - Read More - - - - -
-
-
- {% if page.taxonomies.categories %} - {{ macros::render_categories(categories=page.taxonomies.categories) }} - {% endif %} -
-
- {% if page.taxonomies.tags %} - {{ macros::render_tags(tags=page.taxonomies.tags) }} - {% endif %} -
-
-
- {% endfor %} -
-
-
-
-{% endblock content %} \ No newline at end of file diff --git a/templates/documentation.html b/templates/documentation.html index 7145129..f425d6d 100644 --- a/templates/documentation.html +++ b/templates/documentation.html @@ -1,224 +1,51 @@ {% extends 'base.html' %} {% block title %} -{{ config.title }} | {{ page.title }} + {{ config.title }} | {{ page.title }} {% endblock %} {% block content %} -{% set section = get_section(path="documentation/_index.md") %} -
-
- - - -
-
-
-
-

- {{ page.title }} -

- {% if page.description %} -

{{ page.description }}

- {% endif %} -
-
-
- {{ page.content | safe }} -
-
-
- - -
-
-{% endblock %} - -{% block pagination %} -{% if page.earlier or page.later or page.lighter or page.heavier %} -
-
-
-
- +
+ {% include "partials/doc/page_toc.html" %}
-
-
-{% endif %} -{% endblock %} - -{% block comment %} -{% if page.extra.comments and config.extra.commenting.disqus %} -
-
-
-
-
-
+
+ {% if page.earlier or page.later or page.lighter or page.heavier %} + {% include "partials/doc/pagination.html" %} + {% endif %}
-
-
-{% endif %} + {% endblock %} {% block custom_js %} -{% if page.extra.toc %} - -{% endif %} - -{% if page.extra.comments and config.extra.commenting.disqus %} - -{% endif %} + {% if page.toc %} + {% include "partials/doc/toc_script.html" %} + {% endif %} {% endblock %} \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index 2126007..08cce9c 100755 --- a/templates/index.html +++ b/templates/index.html @@ -4,26 +4,26 @@
-
+
-

{{ config.extra.organization.description }}

-
-
- - Host a Website +

{{ config.extra.organization.description }}

+
+
+ + Host a Website
-
- - Store Media +
+ + Store Media
-
- - Backup Target +
+ + Backup Target
-
+

Our Goals

@@ -64,36 +64,36 @@

We worked hard to keep requirements as low as possible
as we target the largest possible public.

-
    -
  • +
      +
    • CPU
      Any x86_64 CPU from the last 10 years, ARMv7 or ARMv8
      • -
    • +
    • RAM
      1 GB
      • -
    • +
    • Disk space
      At least 16 GB
      • -
    • +
    • Network
      200 ms or less, 50 Mbps or more
      • -
    • +
    • Heterogeneous hardware @@ -103,11 +103,11 @@
-
+

Data resiliency for everyone

- Blabla bla bla bla. + Lorem ipsum dolor sit amet consectetur adipisicing elit.

Garage implements the Amazon S3 API
and thus is already compatible with many applications. @@ -146,10 +146,12 @@

-
+

Built on the shoulder of giants

-

Which means thats you have to be very tall to get it.

+

+ Lorem ipsum dolor sit amet consectetur adipisicing elit. +

  • Dynamo: Amazon’s Highly Available Key-value Store diff --git a/templates/page.html b/templates/page.html index ee83cad..eeba7f1 100755 --- a/templates/page.html +++ b/templates/page.html @@ -19,8 +19,8 @@

    {{ page.description }}

    {% endif %} -
    -
    +
    +
    diff --git a/templates/partials/doc/global_toc.html b/templates/partials/doc/global_toc.html new file mode 100644 index 0000000..ebad287 --- /dev/null +++ b/templates/partials/doc/global_toc.html @@ -0,0 +1,34 @@ + \ No newline at end of file diff --git a/templates/partials/doc/page_toc.html b/templates/partials/doc/page_toc.html new file mode 100644 index 0000000..172e0ce --- /dev/null +++ b/templates/partials/doc/page_toc.html @@ -0,0 +1,33 @@ + \ No newline at end of file diff --git a/templates/partials/doc/pagination.html b/templates/partials/doc/pagination.html new file mode 100644 index 0000000..0170a77 --- /dev/null +++ b/templates/partials/doc/pagination.html @@ -0,0 +1,76 @@ +
    +
    +
    +
    +
    + Navigation +
    + +
    +
    +
    +
    \ No newline at end of file diff --git a/templates/partials/doc/toc_script.html b/templates/partials/doc/toc_script.html new file mode 100644 index 0000000..a858c94 --- /dev/null +++ b/templates/partials/doc/toc_script.html @@ -0,0 +1,55 @@ + \ No newline at end of file diff --git a/templates/tags/list.html b/templates/tags/list.html deleted file mode 100755 index 4100e8d..0000000 --- a/templates/tags/list.html +++ /dev/null @@ -1,27 +0,0 @@ -{% extends "base.html" %} - -{% block content %} -
    -
    -
    -

    - - - - Tags -

    -

    {{ terms | length }} tags in total

    -

    - {% for tag in terms %} - - - - - {{tag.name}} {{ tag.pages | length }} - - {% endfor %} -

    -
    -
    -
    -{% endblock content %} diff --git a/templates/tags/single.html b/templates/tags/single.html deleted file mode 100755 index 3c89294..0000000 --- a/templates/tags/single.html +++ /dev/null @@ -1,76 +0,0 @@ -{% extends "base.html" %} - -{% block header %} -
    -
    -
    -
    -

    - - - - - {{ term.name }} - -

    -
    -
    -
    -
    -{% endblock %} - -{% block content %} -
    -
    -
    -
    - {% if paginator %} - {% set pages = paginator.pages %} - {% else %} - {% set pages = term.pages %} - {% endif %} - - {% for page in pages %} -
    -

    - - {{ page.title }} - -

    -

    {{ page.description }}

    -
    -
    - {{ macros::page_publish_metadata(page=page) }} -
    -
    - {{ macros::page_content_metadata(page=page) }} -
    -
    -
    - {{ page.summary | safe }} - - Read More - - - - -
    -
    -
    - {% if page.taxonomies.categories %} - {{ macros::render_categories(categories=page.taxonomies.categories) }} - {% endif %} -
    -
    - {% if page.taxonomies.tags %} - {{ macros::render_tags(tags=page.taxonomies.tags) }} - {% endif %} -
    -
    -
    - {% endfor %} -
    -
    -
    -
    -{% endblock content %} \ No newline at end of file -- cgit v1.2.3