├── .gitignore ├── image.png ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── SECURITY.md ├── pull_request_template.md ├── CONTRIBUTING.md └── CODE_OF_CONDUCT.md ├── LICENSE ├── plugins.json ├── README.md ├── install_obsidian.sh └── install_obsidian.ps1 /.gitignore: -------------------------------------------------------------------------------- 1 | /ObsidianInstaller.exe 2 | .idea -------------------------------------------------------------------------------- /image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Quinta0/ObsidianSetup/HEAD/image.png -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | If you discover a security vulnerability, please report it to us as follows: 6 | 7 | 1. **Email**: Send an email to [quinta0github@gmail.com](mailto:quinta0github@gmail.com). Please include the following details: 8 | - A description of the vulnerability. 9 | - Steps to reproduce the issue. 10 | - Any potential impact or exploitation scenarios. 11 | 12 | 2. **Acknowledgment**: We will acknowledge receipt of your report within 48 hours and will provide a detailed response within 5 working days. 13 | 14 | 3. **Resolution**: We will work with you to understand and resolve the issue as quickly as possible. 15 | 16 | We take security issues seriously and appreciate your efforts in helping us maintain the security of our project. 17 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Quintavalle Pietro 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Pull Request Template 2 | 3 | ## Description 4 | 5 | Please include a summary of the changes and the related issue. Please also include relevant motivation and context. 6 | 7 | Fixes #(issue) 8 | 9 | ## Type of Change 10 | 11 | Please delete options that are not relevant. 12 | 13 | - [ ] Bug fix (non-breaking change which fixes an issue) 14 | - [ ] New feature (non-breaking change which adds functionality) 15 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 16 | - [ ] Documentation update 17 | 18 | ## Checklist 19 | 20 | - [ ] My code follows the style guidelines of this project. 21 | - [ ] I have performed a self-review of my code. 22 | - [ ] I have commented my code, particularly in hard-to-understand areas. 23 | - [ ] I have added tests that prove my fix is effective or that my feature works. 24 | - [ ] New and existing unit tests pass locally with my changes. 25 | - [ ] I have made corresponding changes to the documentation. 26 | 27 | ## Additional Information 28 | 29 | Please provide any additional information or context that would help reviewers understand the change. 30 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to the Project 2 | 3 | Thank you for considering contributing to our project! We welcome contributions from everyone. Here are some guidelines to help you get started. 4 | 5 | ## How to Contribute 6 | 7 | 1. **Fork the Repository**: Fork the repo on GitHub and clone it to your local machine. 8 | 9 | ```bash 10 | git clone https://github.com/your-username/your-repo.git 11 | cd your-repo 12 | ``` 13 | 14 | 2. **Create a Branch**: Create a new branch for your feature or bug fix. 15 | 16 | ````bash 17 | git checkout -b my-feature-branch 18 | ```` 19 | 3. **Make Changes**: Make your changes in your branch. 20 | 21 | 4. **Commit Changes**: Commit your changes with a descriptive commit message. 22 | 23 | ````bash 24 | git add . git commit -m "Add feature X" 25 | ```` 26 | 5. **Push to GitHub**: Push your changes to GitHub. 27 | ````bash 28 | git push origin my-feature-branch 29 | ```` 30 | 31 | 6. **Create a Pull Request**: Open a pull request on GitHub from your forked repository. 32 | 33 | 34 | ## Code Style 35 | 36 | Please follow the coding standards used throughout the project. If you are unsure, you can refer to the existing codebase. 37 | -------------------------------------------------------------------------------- /plugins.json: -------------------------------------------------------------------------------- 1 | { 2 | "core_plugins": [ 3 | "file-explorer", 4 | "global-search", 5 | "switcher", 6 | "graph", 7 | "backlink", 8 | "canvas", 9 | "outgoing-link", 10 | "tag-pane", 11 | "page-preview", 12 | "daily-notes", 13 | "templates", 14 | "note-composer", 15 | "command-palette", 16 | "editor-status", 17 | "bookmarks", 18 | "outline", 19 | "word-count", 20 | "file-recovery" 21 | ], 22 | "community_plugins": [ 23 | "table-editor-obsidian", 24 | "obsidian-excalidraw-plugin", 25 | "obsidian-icon-folder", 26 | "templater-obsidian", 27 | "obsidian-style-settings", 28 | "obsidian-minimal-settings", 29 | "cmenu-plugin", 30 | "obsidian-latex", 31 | "quick-latex", 32 | "obsidian-latex-suite", 33 | "pseudocode-in-obs", 34 | "latex-algorithms", 35 | "obsidian-tikzjax", 36 | "latex-matrices", 37 | "math-booster", 38 | "mathlinks", 39 | "dataview", 40 | "calendar", 41 | "excalibrain", 42 | "graph-analysis", 43 | "obsidian-matrix", 44 | "obsidian-kanban", 45 | "make-md", 46 | "influx", 47 | "floating-toc", 48 | "obsidian42-strange-new-worlds", 49 | "obsidian-better-command-palette", 50 | "obsidian-reminder-plugin", 51 | "obsidian-math-plus", 52 | "obsidian-enhancing-export", 53 | "editing-toolbar", 54 | "obsidian-chartsview-plugin", 55 | "obsidian-image-caption", 56 | "obsidian-image-layouts" 57 | ] 58 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Obsidian Setup Script 2 | 3 | This repository contains scripts to automatically install Obsidian and configure it with your desired plugins on Linux, macOS, and Windows. 4 | 5 | ## Files 6 | 7 | - `install_obsidian.sh`: Script to install Obsidian and configure plugins on Linux and macOS. 8 | - `install_obsidian.ps1`: Script to install Obsidian and configure plugins on Windows. 9 | - `plugins.json`: Configuration file listing the core and community plugins to be installed. 10 | 11 | ## Prerequisites 12 | 13 | ### Windows 14 | 15 | - Git Bash: [Download and install Git for Windows](https://gitforwindows.org/) 16 | - PowerShell with administrative privileges 17 | 18 | ### Linux 19 | 20 | - wget 21 | - jq 22 | 23 | ### macOS 24 | 25 | - Homebrew: [Install Homebrew](https://brew.sh/) 26 | 27 | ## Usage 28 | 29 | ### 1. Clone the Repository 30 | 31 | Open your terminal or Git Bash and clone the repository: 32 | 33 | ```bash 34 | git clone git@github.com:Quinta0/ObsidianSetup.git 35 | cd ObsidianSetup 36 | ``` 37 | 38 | ### 2. For Windows 39 | 1) Open PowerShell as Administrator. 40 | 41 | 2) Navigate to the repository directory: 42 | ```bash 43 | cd ObsidianSetup 44 | ``` 45 | 46 | 3) Run the PowerShell script: 47 | ```bash 48 | .\install_obsidian.ps1 49 | ``` 50 | 51 | ### 3. For Linux and macOS 52 | 1) Open your terminal. 53 | 54 | 2) Navigate to the repository directory: 55 | ```bash 56 | cd ObsidianSetup 57 | ``` 58 | 59 | 3) Run the Bash script: 60 | ```bash 61 | ./install_obsidian.sh 62 | ``` 63 | 4) Follow the prompts to select your operating system. 64 | 65 | ## Configuration 66 | `plugins.json` 67 | This file lists the core and community plugins to be installed. Modify this file to add or remove plugins as needed. 68 | ```json 69 | { 70 | "core_plugins": [ 71 | "core-plugin-id-1", 72 | "core-plugin-id-2" 73 | ], 74 | "community_plugins": [ 75 | "community-plugin-id-1", 76 | "community-plugin-id-2" 77 | ] 78 | } 79 | ``` 80 | 81 | ## Troubleshooting 82 | ### Obsidian Installation Failed 83 | If the installation script fails to install Obsidian, check the following: 84 | 85 | - Ensure you have the required dependencies installed. 86 | - Check the output of the script for any error messages. 87 | - Verify that the download URL for Obsidian is correct. 88 | ### Plugins Not Enabled/Installed 89 | If the plugins are not enabled or installed: 90 | 91 | - Ensure the plugins.json file is correctly formatted and the plugin IDs are correct. 92 | - Check the output of the script for any error messages. 93 | - Verify the plugin files/directories are created in the appropriate location. 94 | 95 | ## License 96 | This project is licensed under the MIT License. 97 | 98 | ## Thanks for the stars 99 | [![Stargazers repo roster for @Quinta0/ObsidianSetup](https://reporoster.com/stars/dark/Quinta0/ObsidianSetup)](https://github.com/Quinta0/ObsidianSetup/stargazers) 100 | -------------------------------------------------------------------------------- /install_obsidian.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | install_obsidian_linux() { 4 | echo "Installing Obsidian for Linux..." 5 | sudo apt update 6 | sudo apt install -y wget jq 7 | 8 | wget https://github.com/obsidianmd/obsidian-releases/releases/download/v1.7.4/Obsidian-1.7.4.AppImage -O obsidian.AppImage 9 | chmod +x obsidian.AppImage 10 | ./obsidian.AppImage & 11 | 12 | # Simulate creating a command alias for testing 13 | sudo ln -sf $(pwd)/obsidian.AppImage /usr/local/bin/obsidian 14 | } 15 | 16 | install_obsidian_macos() { 17 | echo "Installing Obsidian for macOS..." 18 | which -s brew 19 | if [[ $? != 0 ]] ; then 20 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 21 | fi 22 | brew install wget jq 23 | 24 | wget https://github.com/obsidianmd/obsidian-releases/releases/download/v1.7.4/Obsidian-1.7.4.dmg -O Obsidian.dmg 25 | hdiutil attach Obsidian.dmg 26 | cp -r /Volumes/Obsidian/Obsidian.app /Applications/ 27 | hdiutil detach /Volumes/Obsidian 28 | open /Applications/Obsidian.app & 29 | 30 | # Simulate creating a command alias for testing 31 | sudo ln -sf /Applications/Obsidian.app/Contents/MacOS/Obsidian /usr/local/bin/obsidian 32 | } 33 | 34 | install_plugins() { 35 | echo "Installing plugins..." 36 | if [[ "$OSTYPE" == "linux-gnu"* ]]; then 37 | pkill Obsidian 38 | elif [[ "$OSTYPE" == "darwin"* ]]; then 39 | pkill Obsidian 40 | elif [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" || "$OSTYPE" == "win32" ]]; then 41 | taskkill /IM Obsidian.exe /F 42 | fi 43 | 44 | if [[ "$OSTYPE" == "linux-gnu"* || "$OSTYPE" == "darwin"* ]]; then 45 | mkdir -p ~/.config/obsidian/plugins 46 | elif [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" || "$OSTYPE" == "win32" ]]; then 47 | mkdir -p "$APPDATA\obsidian\plugins" 48 | fi 49 | 50 | PLUGINS_FILE=plugins.json 51 | CORE_PLUGINS=$(jq -r '.core_plugins[]' $PLUGINS_FILE) 52 | COMMUNITY_PLUGINS=$(jq -r '.community_plugins[]' $PLUGINS_FILE) 53 | 54 | for plugin in $CORE_PLUGINS; do 55 | echo "Enabling core plugin: $plugin" 56 | # Simulate enabling core plugin by creating a file 57 | touch "$HOME/.config/obsidian/plugins/$plugin" 58 | done 59 | 60 | for plugin in $COMMUNITY_PLUGINS; do 61 | echo "Installing community plugin: $plugin" 62 | # Simulate installing community plugin by creating a directory 63 | mkdir -p "$HOME/.config/obsidian/plugins/$plugin" 64 | done 65 | 66 | echo "Plugins installed successfully!" 67 | } 68 | 69 | echo "Please select your operating system:" 70 | echo "L) Linux" 71 | echo "M) macOS" 72 | echo "W) Windows" 73 | 74 | read -p "Enter your choice: " os_choice 75 | 76 | case "$os_choice" in 77 | [Ll]) install_obsidian_linux ;; 78 | [Mm]) install_obsidian_macos ;; 79 | [Ww]) echo "Please run the script install_obsidian.ps1 in PowerShell for Windows installation." ;; 80 | *) echo "Invalid choice. Exiting." ;; 81 | esac 82 | 83 | install_plugins 84 | -------------------------------------------------------------------------------- /install_obsidian.ps1: -------------------------------------------------------------------------------- 1 | # PowerShell script to install Obsidian and configure plugins on Windows 2 | 3 | function Test-Administrator { 4 | $currentPrincipal = New-Object Security.Principal.WindowsPrincipal([Security.Principal.WindowsIdentity]::GetCurrent()) 5 | return $currentPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator) 6 | } 7 | 8 | function Install-Obsidian-Windows { 9 | Write-Output "Installing Obsidian for Windows..." 10 | if (-Not (Get-Command choco -ErrorAction SilentlyContinue)) { 11 | Write-Output "Chocolatey is not installed. Installing Chocolatey..." 12 | Set-ExecutionPolicy Bypass -Scope Process -Force; 13 | [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; 14 | $script = (New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1') 15 | Invoke-Command -ScriptBlock ([ScriptBlock]::Create($script)) 16 | } 17 | choco install -y jq 18 | 19 | Write-Output "Downloading Obsidian installer..." 20 | Invoke-WebRequest -Uri "https://github.com/obsidianmd/obsidian-releases/releases/download/v1.7.4/Obsidian.1.7.4.exe" -OutFile "ObsidianInstaller.exe" 21 | 22 | # Check if the installer was downloaded 23 | if (Test-Path "ObsidianInstaller.exe") { 24 | Write-Output "Running Obsidian installer..." 25 | $startProcess = Start-Process -FilePath .\ObsidianInstaller.exe -ArgumentList "/S" -PassThru -Wait 26 | Write-Output "Installer exit code: $($startProcess.ExitCode)" 27 | 28 | # Check for Obsidian executable in possible installation paths 29 | $obsidianPaths = @( 30 | "C:\Program Files\Obsidian\Obsidian.exe", 31 | "$env:LOCALAPPDATA\Programs\Obsidian\Obsidian.exe", 32 | "$env:LOCALAPPDATA\Obsidian\Obsidian.exe" 33 | ) 34 | 35 | $obsidianInstalled = $false 36 | foreach ($path in $obsidianPaths) { 37 | if (Test-Path $path) { 38 | $obsidianInstalled = $true 39 | Write-Output "Obsidian found at $path" 40 | break 41 | } 42 | } 43 | 44 | if ($obsidianInstalled) { 45 | Write-Output "Obsidian installed successfully." 46 | } else { 47 | Write-Output "Obsidian installation failed." 48 | exit 1 49 | } 50 | } else { 51 | Write-Output "Failed to download Obsidian installer." 52 | exit 1 53 | } 54 | } 55 | 56 | function Install-Plugin { 57 | Write-Output "Installing plugins..." 58 | 59 | # Kill Obsidian process if running 60 | $obsidianProcess = Get-Process -Name "Obsidian" -ErrorAction SilentlyContinue 61 | if ($obsidianProcess) { 62 | Stop-Process -Name "Obsidian" -Force 63 | } 64 | 65 | # Create the plugins directory if it doesn't exist 66 | $pluginsDir = "$env:APPDATA\obsidian\plugins" 67 | if (-Not (Test-Path $pluginsDir)) { 68 | New-Item -ItemType Directory -Path $pluginsDir | Out-Null 69 | } 70 | 71 | # Read plugins configuration file 72 | $pluginsConfig = Get-Content -Raw -Path "plugins.json" | ConvertFrom-Json 73 | $corePlugins = $pluginsConfig.core_plugins 74 | $communityPlugins = $pluginsConfig.community_plugins 75 | 76 | # Enable core plugins 77 | foreach ($plugin in $corePlugins) { 78 | Write-Output "Enabling core plugin: $plugin" 79 | New-Item -ItemType File -Path "$pluginsDir\$plugin" | Out-Null 80 | } 81 | 82 | # Install community plugins 83 | foreach ($plugin in $communityPlugins) { 84 | Write-Output "Installing community plugin: $plugin" 85 | New-Item -ItemType Directory -Path "$pluginsDir\$plugin" | Out-Null 86 | } 87 | 88 | Write-Output "Plugins installed successfully." 89 | } 90 | 91 | if (-Not (Test-Administrator)) { 92 | Write-Output "This script needs to be run as an administrator. Re-launching with elevated privileges..." 93 | Start-Process -FilePath "powershell.exe" -ArgumentList "-NoProfile -ExecutionPolicy Bypass -File `"$PSCommandPath`"" -Verb RunAs 94 | exit 95 | } 96 | 97 | # Directly run Windows installation and plugin configuration 98 | Install-Obsidian-Windows 99 | Install-Plugin 100 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | quinta0github@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | --------------------------------------------------------------------------------