diff --git a/README.md b/README.md index 183ea38..ae43131 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,11 @@ pylyzer as a language server supports various features, such as completion and r ## [VSCode extension](https://github.com/mtshiba/pylyzer/blob/main/extension) +## What is the difference from [Ruff](https://github.com/charliermarsh/ruff)? + +[Ruff](https://github.com/charliermarsh/ruff), like pylyzer, is a static code analysis tool for Python written in Rust, but Ruff is a linter and pylyzer is a type checker & language server. +pylyzer does not perform linting, and Ruff does not perform type checking. + ## How it works pylyzer uses the type checker of [the Erg programming language](https://erg-lang.org) internally. diff --git a/docs/assets/pylyzer-logo.png b/docs/assets/pylyzer-logo.png new file mode 100644 index 0000000..3d2af21 Binary files /dev/null and b/docs/assets/pylyzer-logo.png differ diff --git a/docs/assets/pylyzer-logo.svg b/docs/assets/pylyzer-logo.svg new file mode 100644 index 0000000..1fcecb8 --- /dev/null +++ b/docs/assets/pylyzer-logo.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/editor.md b/docs/editor.md new file mode 100644 index 0000000..2be3a59 --- /dev/null +++ b/docs/editor.md @@ -0,0 +1,12 @@ +# Editor integrations + +## VSCode + +* Install [the extension](https://marketplace.visualstudio.com/items?itemName=pylyzer.pylyzer). + +## Neovim + +* [Setup mason](https://github.com/williamboman/mason.nvim). +* Type `:MasonInstall pylyzer` in Neovim. + +> If you use [LunarVim](https://www.lunarvim.org/), no setup is required. Just install pylyzer and you are good to go. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b11515d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: pylyzer +theme: + name: material + logo: assets/pylyzer-logo.svg + favicon: assets/pylyzer-logo.png + features: + - navigation.instant + - navigation.tracking + - content.code.annotate + - toc.integrate + - toc.follow + - navigation.path + - navigation.top + - content.code.copy + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + toggle: + icon: material/weather-sunny + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: indigo + toggle: + icon: material/weather-night + name: Switch to light mode +repo_url: https://github.com/mtshiba/pylyzer +repo_name: pylyzer +site_author: Shunsuke Shibayama +site_url: https://mtshiba.github.io/pylyzer/ +markdown_extensions: + - toc: + permalink: "#" + - pymdownx.snippets: + - pymdownx.magiclink: + - attr_list: + - md_in_html: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite: + - pymdownx.superfences: + - markdown.extensions.attr_list: + - pymdownx.keys: + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.highlight: + anchor_linenums: true +plugins: + - search \ No newline at end of file diff --git a/mkdocs_build.bat b/mkdocs_build.bat new file mode 100644 index 0000000..a3c6774 --- /dev/null +++ b/mkdocs_build.bat @@ -0,0 +1 @@ +copy README.md docs\index.md