https://github.com/system76/tech-docs

System76 Technical Documentation
https://github.com/system76/tech-docs

Last synced: 6 days ago
JSON representation

System76 Technical Documentation

• Host: GitHub
• URL: https://github.com/system76/tech-docs
• Owner: system76
• License: gpl-3.0
• Created: 2020-01-26T01:54:31.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-24T06:59:02.000Z (16 days ago)
• Last Synced: 2024-12-26T22:16:06.313Z (13 days ago)
• Language: CSS
• Homepage: https://tech-docs.system76.com
• Size: 1.12 GB
• Stars: 54
• Watchers: 25
• Forks: 13
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# System76 Technical Documentation

This repository contains the Technical documentation about System76 products. It

can be viewed at https://tech-docs.system76.com.

## Editing

There are two methods to view and edit the book. There is a quick method that

does not include additional UI elements such as search, and the complete way

that will render the book as it is rendered on the official website.

### GitHub (Quick)

The book can be viewed and edited on GitHub by going to

[src/README.md](src/README.md).

### mdBook (Complete)

- Install [mdBook](https://github.com/rust-lang/mdBook#installation)

- Clone the repository using `git`.

- From the cloned repository, run `mdbook serve`

- You may now view the book at `http://localhost:3000`

- Edits are made in the `src` directory. The server will automatically update