https://github.com/clearurls/docs

Documentation of ClearURLs.
https://github.com/clearurls/docs

Last synced: 8 months ago
JSON representation

Documentation of ClearURLs.

• Host: GitHub
• URL: https://github.com/clearurls/docs
• Owner: ClearURLs
• Created: 2021-03-29T22:01:16.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2025-02-24T18:42:13.000Z (over 1 year ago)
• Last Synced: 2025-04-22T17:12:56.232Z (about 1 year ago)
• Language: CSS
• Homepage: http://docs.clearurls.xyz
• Size: 1.49 MB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Overview

This repository includes the source files used to build the documentation used for the official documentation site. You can visit the official documentation site here: https://docs.clearurls.xyz/

# Build

Use the given Makefile to build the doc: `make docs`

# Develop

Use the given Makefile to develop. You can see all changes in realtime with: `make docs-serve`

# Release

`mike deploy --push --update-aliases  latest`

or for dev versions

`mike deploy --push --update-aliases  dev`