gitpad/README.md

38 lines
1.1 KiB
Markdown
Raw Normal View History

2022-02-11 12:11:54 +00:00
<div align="center">
<h1> Gists </h1>
<p>
**Self-Hosted GitHub Gists**
2022-02-11 12:11:54 +00:00
</p>
[![Build](https://github.com/realaravinth/gists/actions/workflows/linux.yml/badge.svg)](https://github.com/realaravinth/gists/actions/workflows/linux.yml)
[![dependency status](https://deps.rs/repo/github/realaravinth/gists/status.svg)](https://deps.rs/repo/github/realaravinth/gists)
[![codecov](https://codecov.io/gh/realaravinth/gists/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/gists)
</div>
## Features
2022-02-18 18:29:37 +00:00
- [ ] Upload code snippets(&check; REST API)
2022-02-11 12:11:54 +00:00
- [ ] Syntax Highlighting
- [ ] Comments
2022-02-18 18:29:37 +00:00
- [x] Versioning through Git
2022-02-11 12:11:54 +00:00
- [ ] Fork gists
2022-02-18 18:29:37 +00:00
- [x] Gist privacy: public, unlisted, private
- [ ] Git clone via HTTP and SSH
2022-02-11 12:11:54 +00:00
- [ ] Activity Pub implementation for publishing native gists and commenting
- [ ] Gitea OAuth integration
2022-02-11 12:11:54 +00:00
## Why?
Gists are nice, while there are wonderful forges like
[Gitea](https://gitea.io), there isn't a libre pastebin implementation that
can rival GitHub Gists.
## Usage
1. All configuration is done through
[./config/default.toml](./config/default.toml)(can be moved to
`/etc/gists/config.toml`).