diff --git a/.github/mkdocs.yml b/.github/mkdocs.yml deleted file mode 100644 index df5e17a..0000000 --- a/.github/mkdocs.yml +++ /dev/null @@ -1,75 +0,0 @@ -site_name: -{{ REPO_NAME }}- -theme: - name: material - language: en - font: - text: Roboto - code: Sono - logo: Assets/icon.png - favicon: Assets/icon.png - palette: - # Palette toggle for automatic mode - - media: "(prefers-color-scheme)" - toggle: - icon: material/link - name: Switch to dark mode - # Palette toggle for dark mode - - media: '(prefers-color-scheme: dark)' - scheme: slate - toggle: - primary: black - accent: green - icon: material/toggle-switch-off-outline - name: Switch to light mode - # Palette toggle for light mode - - media: '(prefers-color-scheme: light)' - scheme: default - toggle: - primary: indigo - accent: green - icon: material/toggle-switch - name: Switch to system preference - icon: - repo: material/github - features: - - navigation.instant - - navigation.instant.progress - - navigation.indexes - - navigation.top - - navigation.tracking - - navigation.expand - - search.suggest - - search.highlight - -repo_name: -{{ REPO_OWNER }}-/-{{ REPO_NAME }}- -repo_url: https://github.com/-{{ REPO_OWNER }}-/-{{ REPO_NAME }}- - -plugins: - - search - -markdown_extensions: - - toc: - permalink: true # Adds a link icon to headings - - attr_list - - admonition - - md_in_html - - pymdownx.details # Enables collapsible admonitions - -extra: - social: - - icon: fontawesome/brands/discord - link: https://discord.gg/jedJWCPAhD - name: -{{ REPO_OWNER }}- on Discord - - icon: fontawesome/brands/github - link: https://github.com/-{{ REPO_OWNER }}-/ - name: -{{ REPO_OWNER }}- on GitHub - consent: - title: Cookie consent - description: >- - We use cookies to recognize your repeated visits and preferences, as well - as to measure the effectiveness of our documentation and whether users - find what they're searching for. With your consent, you're helping us to - make our documentation better. - actions: - - accept - - reject diff --git a/.github/zensical.toml b/.github/zensical.toml new file mode 100644 index 0000000..d92b3db --- /dev/null +++ b/.github/zensical.toml @@ -0,0 +1,131 @@ +# Zensical configuration +# https://zensical.org/docs/setup/basics/ +# Process-PSModule v8 copies this file into outputs/site and stages generated +# documentation under outputs/site/docs. + +[project] +site_name = "Fonts" +site_url = "https://psmodule.io/Fonts/" +docs_dir = "docs" +repo_name = "PSModule/Fonts" +repo_url = "https://github.com/PSModule/Fonts" +edit_uri = "edit/main/" +copyright = "Copyright © 2023 - 2026 PSModule" +extra_javascript = [ + "https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js", + # The v8 site assembly does not copy repository override directories. + "https://cdn.jsdelivr.net/gh/PSModule/Process-PSModule@59e056cab018777a8f158f88fcabdb57125494ef/docs/overrides/assets/javascripts/tablesort.js", +] +extra_css = [ + # Pin the current Process-PSModule navigation behavior used as the baseline. + "https://cdn.jsdelivr.net/gh/PSModule/Process-PSModule@59e056cab018777a8f158f88fcabdb57125494ef/docs/overrides/assets/stylesheets/navigation.css", +] +[project.theme] +language = "en" +font.text = "Mona Sans" +font.code = "Source Code Pro" +logo = "https://raw.githubusercontent.com/PSModule/Fonts/main/icon/icon.png" +favicon = "https://raw.githubusercontent.com/PSModule/Fonts/main/icon/icon.png" +features = [ + "announce.dismiss", + "content.code.annotate", + "content.code.copy", + "content.tooltips", + "navigation.expand", + "navigation.footer", + "navigation.indexes", + "navigation.instant", + "navigation.instant.prefetch", + "navigation.instant.preview", + "navigation.instant.progress", + "navigation.tabs", + "navigation.top", + "navigation.tracking", + "search.highlight", + "search.share", + "search.suggest", + "toc.follow", +] + +[project.theme.icon] +repo = "material/github" +link = "material/link-variant" + +[[project.theme.palette]] +media = "(prefers-color-scheme)" +toggle.icon = "material/link" +toggle.name = "Switch to dark mode" + +[[project.theme.palette]] +media = "(prefers-color-scheme: dark)" +scheme = "slate" +primary = "black" +accent = "light blue" +toggle.icon = "material/toggle-switch-off-outline" +toggle.name = "Switch to light mode" + +[[project.theme.palette]] +media = "(prefers-color-scheme: light)" +scheme = "default" +primary = "black" +accent = "light blue" +toggle.icon = "material/toggle-switch" +toggle.name = "Switch to system preference" + +[project.plugins.meta] + +[project.plugins.search] + +[project.markdown_extensions.toc] +permalink = "#" + +[project.markdown_extensions.attr_list] + +[project.markdown_extensions.abbr] + +[project.markdown_extensions.admonition] + +[project.markdown_extensions.def_list] + +[project.markdown_extensions.footnotes] + +[project.markdown_extensions.md_in_html] + +[project.markdown_extensions.tables] + +[project.markdown_extensions.pymdownx.details] + +[project.markdown_extensions.pymdownx.superfences] +custom_fences = [ + { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }, +] + +[project.markdown_extensions.pymdownx.tasklist] +custom_checkbox = true + +[project.markdown_extensions.pymdownx.snippets] + +[project.extra.consent] +title = "Cookie consent" +description = """ + We use cookies to recognize your repeated visits and preferences, as well + as to measure the effectiveness of our documentation and whether users + find what they're searching for. With your consent, you're helping us to + make our documentation better. +""" +actions = ["accept", "reject"] + +[[project.extra.social]] +icon = "fontawesome/brands/discord" +link = "https://discord.gg/jedJWCPAhD" +name = "PSModule on Discord" + +[[project.extra.social]] +icon = "material/powershell" +link = "https://www.powershellgallery.com/packages/Fonts" +name = "Fonts on the PowerShell Gallery" + +[[project.extra.social]] +icon = "fontawesome/brands/github" +link = "https://github.com/PSModule/Fonts" +name = "Fonts on GitHub" diff --git a/README.md b/README.md index 22e2735..ed07171 100644 --- a/README.md +++ b/README.md @@ -84,5 +84,5 @@ Please see the issues tab on this project and submit a new issue that matches yo ### For Developers -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. +If you do code, we'd love to have your contributions. You can help by picking up an +[existing issue](https://github.com/PSModule/Fonts/issues) or submitting a new one if you have an idea for a feature or improvement.