https://github.com/weserv/docs

Documentation for wsrv.nl.
https://github.com/weserv/docs

Last synced: 10 days ago
JSON representation

Documentation for wsrv.nl.

• Host: GitHub
• URL: https://github.com/weserv/docs
• Owner: weserv
• License: mit
• Created: 2019-09-01T20:13:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-31T16:30:47.000Z (7 months ago)
• Last Synced: 2024-12-08T11:41:00.924Z (20 days ago)
• Language: TypeScript
• Homepage: https://wsrv.nl/
• Size: 7.56 MB
• Stars: 112
• Watchers: 3
• Forks: 65
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • Changelog: news/2018/07/29/introducing-api-4.md
  • License: LICENSE
  • Support: docs/supported-colors.md

Awesome Lists containing this project

README

        
# weserv/docs

Documentation for [wsrv.nl](https://wsrv.nl/).

## Built with

- [Node.js](https://nodejs.org/)

- [VitePress](https://github.com/vuejs/vitepress)

## Getting started

```shell

git clone https://github.com/weserv/docs.git

cd docs

yarn # OR npm install

```

### As easy as 1, 2, 3

```shell

# Create a markdown file and write something

echo '# Hello World' > docs/Hello.md

# Start writing

yarn run dev # OR npm run dev

# Build to static files

yarn run build # OR npm run build

# Serve dist/

docker run -d -p 8080:80 -v "$(pwd)/dist:/var/www/imagesweserv/public" --shm-size=1gb --name=weserv ghcr.io/weserv/images:5.x

# Visit http://localhost:8080/

```