https://github.com/0install/docs

Zero Install documentation web-site
https://github.com/0install/docs

Last synced: 7 days ago
JSON representation

Zero Install documentation web-site

• Host: GitHub
• URL: https://github.com/0install/docs
• Owner: 0install
• License: cc-by-sa-4.0
• Created: 2018-08-08T08:06:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-29T23:16:50.000Z (8 months ago)
• Last Synced: 2024-08-01T15:29:41.075Z (3 months ago)
• Homepage: https://docs.0install.net
• Size: 21.9 MB
• Stars: 58
• Watchers: 7
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

• jimsghstars - 0install/docs - Zero Install documentation web-site (Others)

README

        
# Zero Install Documentation

This repository holds the sources for the [Zero Install documentation website](https://docs.0install.net/).

We use [MkDocs](https://www.mkdocs.org/) to generate static web pages from the Markdown files (`*.md`) located in the [docs/](docs/) directory.

## Preview

To get a preview of the website while editing the content run:

    pip install -r requirements.txt

    mkdocs serve

If you have Docker you can instead run:

    docker-compose up

You can now open an automatically refreshing preview in you browser at: http://127.0.0.1:8000/

## Building

Commits to the `master` branch are automatically built and published.

To generate the HTML files locally run:

    mkdocs build

If you have Docker you can instead run:

    docker-compose run mkdocs build

You can now find the generated HTML files in the `site/` directory.