explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2024-12-26 01:46:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Doc changes for local website setup (#3651)

Browse Source
This commit is contained in:
Brad Jascob 2019-04-27 05:28:23 -06:00 committed by Ines Montani
parent fa94f83697
commit 6fcafcc564
2 changed files with 2 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -447,17 +447,7 @@ use the `get_doc()` utility function to construct it manually.
## Updating the website ## Updating the website
Our [website and docs](https://spacy.io) are implemented in For instructions on how to build and run the [website](https://spacy.io) locally see **[Setup and installation](https://github.com/explosion/spaCy/blob/master/website/README.md#setup-and-installation-setup)** in the *website* directory's README.
[Jade/Pug](https://www.jade-lang.org), and built or served by
[Harp](https://harpjs.com). Jade/Pug is an extensible templating language with a
readable syntax, that compiles to HTML. Here's how to view the site locally:
```bash
sudo npm install --global harp
git clone https://github.com/explosion/spaCy
cd spaCy/website
harp server
```
The docs can always use another example or more detail, and they should always The docs can always use another example or more detail, and they should always
be up to date and not misleading. To quickly find the correct file to edit, be up to date and not misleading. To quickly find the correct file to edit,

2
website/README.md
View File

@ -457,7 +457,7 @@ sit amet dignissim justo congue.
## Setup and installation {#setup} ## Setup and installation {#setup}
Before running the setup, make sure your versions of Before running the setup, make sure your versions of
[Node](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) are up to date. [Node](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) are up to date. Node v10.15 or later is required.
```bash ```bash
# Clone the repository # Clone the repository