diff --git a/docs/index.md b/docs/index.md index 2347c1d..f678fda 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,10 @@ -# Beginning +--- +hide: + - navigation + - toc +--- + +# Home !!! warning diff --git a/docs/install.md b/docs/install.md deleted file mode 100644 index fb20353..0000000 --- a/docs/install.md +++ /dev/null @@ -1,6 +0,0 @@ -# Installation - -!!! warning - - Site still in developing... - Please wait diff --git a/docs/scripts/tablesort.js b/docs/scripts/tablesort.js new file mode 100644 index 0000000..470a01b --- /dev/null +++ b/docs/scripts/tablesort.js @@ -0,0 +1,6 @@ +document$.subscribe(function() { + var tables = document.querySelectorAll("article table:not([class])") + tables.forEach(function(table) { + new Tablesort(table) + }) + }) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d1c4e73..4e93d32 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,8 +18,8 @@ copyright: Copyright © 2024 NiTiS-Dev theme: name: material logo: assets/logo.png - custom_dir: overrides favicon: assets/favicon.ico + custom_dir: overrides icon: alternate: material/translate-variant repo: material/github @@ -45,33 +45,39 @@ theme: icon: material/toggle-switch-off name: Switch to system preference features: - - search.suggest - - search.highlight - - search.share - - content.code.copy - - content.code.select - - content.code.annotate - - content.action.edit - - content.action.view - - content.tooltips - - navigation.top - - navigation.footer + - search.suggest # Suggestion while search + - search.highlight # Highlight search phrase + - search.share # Share search result + - content.code.copy # Copy button at edge of code block + - content.action.edit # Edit button on begin of page + - content.action.view # View button on begin of page + - navigation.sections # More prettier view of pages; Off this to enable tree view + - navigation.tabs # Root pages are tabs now + - navigation.top # Back to top button + - navigation.instant # Use XHR to prevent page reload + - navigation.instant.progress # Shows progress of instant loading? + - navigation.tracking # Dynamically update link during page reading + - toc.follow # Toc following plugins: - - search - - social: + - search # Search bar + - minify: + minify_html: true # Makes html human-readable + - social: # Social card (for Discord, Twitter, etc.) cards_layout_options: - background_color: "#242048" # The same colour as in the logo + background_color: "#242048" # The same color as in the logo -watch: +watch: # Directories, that need to included - includes markdown_extensions: - - abbr - - admonition - - attr_list - - md_in_html - - pymdownx.tabbed: + - abbr # Abbreviation support + - admonition # Admonitions + - attr_list # Append attributes in markdown + - md_in_html # Use tables, etc. + - toc: # Table of content on right + permalink: true + - pymdownx.tabbed: # Tabs, that you can switch alternate_style: true - pymdownx.highlight: anchor_linenums: true @@ -88,25 +94,13 @@ markdown_extensions: auto_append: - includes/abbreviations.md - pymdownx.superfences - - toc: - permalink: true - -nav: - - index.md - - install.md - - Runtime: - - runtime/versions/zero.md - - runtime/list_of_all_bytecodes.md - - Guidelines: - - guidelines/naming-guideline.md extra_javascript: - - scripts/feedback.js - - + - /scripts/feedback.js + - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js + - /scripts/tablesort.js extra: - generator: false consent: title: Cookie consent description: > @@ -120,15 +114,6 @@ extra: social: - icon: material/github link: https://github.com/nitis-languages - - - # alternate: - # - name: English - # link: / - # lang: en - # - name: Russian - # link: /ru/ - # lang: ru analytics: provider: google property: !ENV GOOGLE_ANALYTICS_KEY @@ -146,3 +131,11 @@ extra: note: >- Thanks for your feedback! Help us improve this page by using our feedback form. + +nav: + - index.md + - Runtime: + - runtime/versions/zero.md + - runtime/list_of_all_bytecodes.md + - Guidelines: + - guidelines/naming-guideline.md \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index b763e73..f3b42bd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,4 +9,5 @@ babel~=2.10 colorama~=0.4 paginate~=0.5 regex>=2022.4 -requests~=2.26 \ No newline at end of file +requests~=2.26 +mkdocs-minify-plugin~=0.7 \ No newline at end of file