d60997febb
* Remove old model shortcuts * Remove error, docs warnings about shortcuts * Fix import in util Accidentally deleted the whole import and not just the old part... * Change universe example to v3 style * Switch ubuntu-latest to ubuntu-20.04 in main tests (#11928) * Switch ubuntu-latest to ubuntu-20.04 in main tests * Only use 20.04 for 3.6 * Update some model loading in Universe * Add v2 tag to neuralcoref * Use the spacy-version feature instead of a v2 tag Co-authored-by: svlandeg <svlandeg@github.com> |
||
|---|---|---|
| .. | ||
| docs | ||
| meta | ||
| setup | ||
| src | ||
| .eslintrc | ||
| .prettierrc | ||
| Dockerfile | ||
| gatsby-browser.js | ||
| gatsby-config.js | ||
| gatsby-node.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| runtime.txt | ||
| UNIVERSE.md | ||
spacy.io website and docs
The styleguide for the spaCy website is available at spacy.io/styleguide.
Setup and installation
Before running the setup, make sure your versions of Node and npm are up to date. Node v10.15 or later is required.
# Clone the repository
git clone https://github.com/explosion/spaCy
cd spaCy/website
# Install Gatsby's command-line tool
npm install --global gatsby-cli
# Install the dependencies
npm install
# Start the development server
npm run dev
If you are planning on making edits to the site, you should also set up the
Prettier code formatter. It takes care of formatting
Markdown and other files automatically.
See here for the available
extensions for your code editor. The
.prettierrc
file in the root defines the settings used in this codebase.
Building & developing the site with Docker
Sometimes it's hard to get a local environment working due to rapid updates to node dependencies, so it may be easier to use docker for building the docs.
If you'd like to do this, be sure you do not include your local
node_modules folder, since there are some dependencies that need to be built
for the image system. Rename it before using.
docker run -it \
-v $(pwd):/spacy-io/website \
-p 8000:8000 \
ghcr.io/explosion/spacy-io \
gatsby develop -H 0.0.0.0
This will allow you to access the built website at http://0.0.0.0:8000/ in your browser, and still edit code in your editor while having the site reflect those changes.
Note: If you're working on a Mac with an M1 processor, you might see
segfault errors from qemu if you use the default image. To fix this use the
arm64 tagged image in the docker run command
(ghcr.io/explosion/spacy-io:arm64).
Building the Docker image
If you'd like to build the image locally, you can do so like this:
docker build -t spacy-io .
This will take some time, so if you want to use the prebuilt image you'll save a bit of time.
Project structure
├── docs # the actual markdown content
├── meta # JSON-formatted site metadata
| ├── languages.json # supported languages and statistical models
| ├── sidebars.json # sidebar navigations for different sections
| ├── site.json # general site metadata
| ├── type-annotations.json # Type annotations
| └── universe.json # data for the spaCy universe section
├── public # compiled site
├── setup # Jinja setup
├── src # source
| ├── components # React components
| ├── fonts # webfonts
| ├── images # images used in the layout
| ├── plugins # custom plugins to transform Markdown
| ├── styles # CSS modules and global styles
| ├── templates # page layouts
| | ├── docs.js # layout template for documentation pages
| | ├── index.js # global layout template
| | ├── models.js # layout template for model pages
| | └── universe.js # layout templates for universe
| └── widgets # non-reusable components with content, e.g. changelog
├── .eslintrc.json # ESLint config file
├── .prettierrc # Prettier config file
├── gatsby-browser.js # browser-specific hooks for Gatsby
├── gatsby-config.js # Gatsby configuration
├── gatsby-node.js # Node-specific hooks for Gatsby
└── package.json # package settings and dependencies