Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/selfhosters/selfhosters.net
https://github.com/selfhosters/selfhosters.net
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/selfhosters/selfhosters.net
- Owner: selfhosters
- Created: 2020-01-12T10:17:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T07:40:54.000Z (7 months ago)
- Last Synced: 2024-08-01T12:22:59.297Z (3 months ago)
- Homepage: https://selfhosters.net/
- Size: 4.16 MB
- Stars: 22
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Selfhosters.net](https://selfhosters.net/)
[![Unraid](https://raw.githubusercontent.com/selfhosters/unRAID-CA-templates/master/.github/ISSUE_TEMPLATE/discord_unraid_unraid.png )](https://discord.gg/qWPbc8R)
[![Discord](https://img.shields.io/discord/641230698166091777?color=%23ff8c2f&label=Discord&logo=discord&logoColor=%23ff8c2f&style=for-the-badge)](https://discord.gg/qWPbc8R)
[![GitHub contributors](https://img.shields.io/github/contributors/selfhosters/selfhosters.net.svg?color=%23ff8c2f&style=for-the-badge)](https://github.com/selfhosters/selfhosters.net/graphs/contributors)Repository for the selfhosters.net documentation.
## Start documenting
Create or edit a markdown(.md) file in the [/docs](/docs/) folder.
It's based on markdown, so looking at a [cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatshee), and checking changes against a [live preview](https://markdownlivepreview.com/) helps you confirm the changes appear like you want them to.
## Start documenting (and seeing changes live)
### Clone repository
```bash
git clone https://github.com/selfhosters/selfhosters.net.git
cd selfhosters.net/
```### Create and activate python virtual environment ([docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/))
```bash
python3 -m venv ./venv
source venv/bin/activate
```### Install required packages
```bash
pip install -r requirements.txt
```### Start the dev-server
```bash
mkdocs serve
```### Write your documentation
### Commit your changes