spaCy/website/README.md

20 lines
926 B
Markdown
Raw Normal View History

2016-10-03 18:19:13 +00:00
<a href="https://explosion.ai"><img src="https://explosion.ai/assets/img/logo.svg" width="125" height="125" align="right" /></a>
2015-09-24 10:23:48 +00:00
2016-10-03 18:19:13 +00:00
# Source files for the spacy.io website and docs
2015-09-24 10:23:48 +00:00
2016-10-03 18:19:13 +00:00
The [spacy.io](https://spacy.io) website is implemented in [Jade (aka Pug)](https://www.jade-lang.org), and is built or served by [Harp](https://harpjs.com). Jade is an extensible templating language with a readable syntax, that compiles to HTML.
The website source makes extensive use of Jade mixins, so that the design system is abstracted away from the content you're
2016-10-03 18:21:33 +00:00
writing. You can read more about our approach in our blog post, ["Rebuilding a Website with Modular Markup Components"](https://explosion.ai/blog/modular-markup).
2015-09-24 10:23:48 +00:00
2016-10-03 18:19:13 +00:00
## Building the site
2015-09-24 10:23:48 +00:00
2016-10-03 18:19:13 +00:00
```bash
sudo npm install --global harp
2016-10-03 18:21:33 +00:00
git clone https://github.com/explosion/spacy
cd website
2016-10-03 18:19:13 +00:00
harp server
```
2015-09-24 10:23:48 +00:00
2016-10-03 18:19:13 +00:00
This will serve the site on [http://localhost:9000](http://localhost:9000).