https://github.com/tmpim/casket-docs
Documentation for Casket by tmpim, mholt's Caddy v1 but maintained
https://github.com/tmpim/casket-docs
Last synced: 5 months ago
JSON representation
Documentation for Casket by tmpim, mholt's Caddy v1 but maintained
- Host: GitHub
- URL: https://github.com/tmpim/casket-docs
- Owner: tmpim
- Created: 2024-01-21T20:25:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T14:32:34.000Z (about 2 years ago)
- Last Synced: 2025-10-19T09:58:48.516Z (8 months ago)
- Language: JavaScript
- Size: 1.27 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# casket-docs
This repository contains the documentation for [Casket](https://github.com/tmpim/casket), a fork of [mholt's Caddy web
server](https://github.com/caddyserver/caddy) v1. This documentation is forked from the Caddy v1 docs as of June 2020,
converted from HTML to Markdown in [this
commit](https://github.com/tmpim/casket-docs/commit/2ac4b866cad687f52a94d262ee2687a5b4e60acd), and then updated to
reflect the changes in Casket.
For more information on what Casket is, see the [Casket repository](https://github.com/tmpim/casket), or the [Casket
documentation](https://docs.casketserver.com/).
## Contributing
If you find a typo or other error in the documentation, please open an issue or pull request. The documentation is
written in [Markdown](https://commonmark.org/help/) and is located in the `docs` directory.
## Building
The documentation is built with [VitePress](https://vitepress.dev/), and is compatible with VitePress's [markdown
extensions](https://vitepress.dev/guide/markdown). To build the documentation and preview it in your browser, you will
need to install [Node.js](https://nodejs.org/en/). Then, run the following commands:
```shell
# Set up the repository
git clone https://github.com/tmpim/casket-docs.git
# Install the dependencies
yarn
# Preview the documentation
yarn dev
```