Spyder Website

Copyright © 2016-2020 Spyder Website Contributors and others (see AUTHORS.txt)

This is the repository for the Spyder IDE website at Spyder-IDE.org, built with the Lektor static CMS and our very own Lektor-Icon theme.

• Getting started
  • Clone the repo with submodules
  • Install dependencies
  • Set up Pre-Commit
  • Run server and make changes
• Workflow
• Technologies and libraries used
  • Lektor plugins
• More information

Getting started

Clone the repo with submodules

git clone --recursive https://github.com/spyder-ide/website-spyder.git

Install dependencies

You can install the required development and production dependencies with conda (recommended):

conda install -c conda-forge --file requirements-dev.txt

or with pip:

pip install -r requirements-dev.txt

Set up Pre-Commit

This repository uses pre-commit to install, configure and update a suite of pre-commit hooks that check for common problems and issues and fix many of them automatically. Pre-commit itself is installed with the above command, and the hooks can be installed by running the following from the root of this repo:

pre-commit install
pre-commit install --hook-type commit-msg

The hooks will be automatically run against any new/changed files every time you commit. It may take a few minutes to install the needed packages the first time you commit, but subsequent runs should only take a few seconds. If you made one or more commits before installing the hooks (not recommended), to run them manually on all the files in the repo, execute:

pre-commit run --all-files

Note: Most of the hooks fix the problems they detect automatically (the hook output will say files were modified by this hook, but no errors/warnings will be listed), but they will still abort the commit so you can double-check everything first. Once you're satisfied, git add . again and re-commit.

Run server and make changes

In the root of this repository, run a continuously updating local webserver:

lektor server

The resulting website can be viewed in your browser at http://localhost:5000.

Workflow

The default branch is master, which is continuously deployed with a Github Action to Github Pages at the domain Spyder-IDE.org.

Technologies and libraries used

This website is built using Lektor, a static web generator that can be customized using Jinja2 templates.

Lektor plugins

The build also requires several Lektor plugins (no extra configuration is needed; Lektor automatically installs them when building):

• disqus-comments
• atom

More information

Main Website

Download Spyder (with Anaconda)

Online Documentation

Spyder Github

Troubleshooting Guide and FAQ

Development Wiki

Gitter Chatroom

Google Group

@Spyder_IDE on Twitter

@SpyderIDE on Facebook

Support Spyder on OpenCollective