https://github.com/tmpfs/circus-village
Circus village website
https://github.com/tmpfs/circus-village
makestatic static website
Last synced: 4 months ago
JSON representation
Circus village website
- Host: GitHub
- URL: https://github.com/tmpfs/circus-village
- Owner: tmpfs
- Created: 2016-04-30T00:17:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-24T02:25:14.000Z (about 6 years ago)
- Last Synced: 2025-01-05T02:12:16.054Z (6 months ago)
- Topics: makestatic, static, website
- Language: JavaScript
- Homepage: https://circus-village.com
- Size: 103 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Circus Village
Static website for the circus village.
---
- [Developer](#developer)
- [Site](#site)
- [Gallery](#gallery)
- [Slides](#slides)
- [Readme](#readme)
- [Lint](#lint)
- [Deploy](#deploy)
- [License](#license)
---
## Developer
Install dependencies (`yarn install`) and the mkdoc tools globally (`yarn global add mkdoc`) then you can see the available tasks with `mk --tasks`. You also need [makestatic][] installed globally.
### Site
Build the static website:
```shell
makestatic
```
Build and serve the website with [browsersync][] enabled:
```shell
makestatic -w
```
### Gallery
Build the `gallery.json` file describing the gallery images:
```shell
mk gallery
```
### Slides
Build the `slides.json` list of slideshow images:
```shell
mk slides
```
### Readme
Build [README.md](https://github.com/circus-village/website/blob/master/README.md):
```shell
mk readme
```
### Lint
Lint the javascript source:
```shell
npm run lint
```
### Deploy
```shell
makestatic --clean --env stage --provider s3
makestatic --clean --env production --provider s3
```
## License
MIT
---
Created by [mkdoc](https://github.com/mkdoc/mkdoc) on April 6, 2017
[browsersync]: http://browsersync.io
[makestatic]: https://makestatic.ws