feat: add documentation for connecting social media platforms and getting started guide
This commit is contained in:
parent
acd7687447
commit
f55e172647
27 changed files with 186 additions and 11 deletions
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Home
|
||||
layout: home
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# TryPost Documentation
|
||||
|
||||
Welcome to the TryPost documentation. Here you'll find everything you need to install, configure, and use TryPost.
|
||||
|
|
@ -38,7 +44,7 @@ ## Self-Hosting
|
|||
|
||||
## Contributing
|
||||
|
||||
- [Contributing Guide](contributing)
|
||||
- [Contributing Guide](./contributing.md)
|
||||
|
||||
## Support
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,30 @@
|
|||
title: TryPost Documentation
|
||||
title: TryPost
|
||||
description: Documentation for TryPost - Open source social media scheduling
|
||||
theme: jekyll-theme-minimal
|
||||
markdown: kramdown
|
||||
remote_theme: just-the-docs/just-the-docs
|
||||
color_scheme: light
|
||||
|
||||
# Navigation
|
||||
header_pages:
|
||||
- getting-started/installation.md
|
||||
- platforms/README.md
|
||||
- features/scheduling.md
|
||||
- self-hosting/requirements.md
|
||||
- contributing.md
|
||||
# Logo
|
||||
logo: "/assets/images/logo.png"
|
||||
|
||||
# Search
|
||||
search_enabled: true
|
||||
search:
|
||||
heading_level: 2
|
||||
previews: 3
|
||||
|
||||
# Aux links (top right)
|
||||
aux_links:
|
||||
"GitHub":
|
||||
- "https://github.com/trypost-it/trypost"
|
||||
|
||||
aux_links_new_tab: true
|
||||
|
||||
# Footer
|
||||
footer_content: "Copyright © 2025 TryPost. Distributed under the <a href=\"https://github.com/trypost-it/trypost/blob/main/LICENSE.md\">FSL License</a>."
|
||||
|
||||
# Back to top link
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
|
||||
# Exclude files
|
||||
exclude:
|
||||
|
|
|
|||
BIN
docs/assets/images/logo.png
Normal file
BIN
docs/assets/images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: Contributing
|
||||
nav_order: 6
|
||||
---
|
||||
|
||||
# Contributing to TryPost
|
||||
|
||||
Thank you for your interest in contributing to TryPost! This guide will help you get started.
|
||||
|
|
|
|||
9
docs/features/index.md
Normal file
9
docs/features/index.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Features
|
||||
has_children: true
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
# Features
|
||||
|
||||
Learn about TryPost's powerful features.
|
||||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Scheduling
|
||||
parent: Features
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# Scheduling Posts
|
||||
|
||||
TryPost makes it easy to schedule your social media content in advance.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Team Management
|
||||
parent: Features
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
# Team Management
|
||||
|
||||
Invite team members to collaborate on your social media content.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Workspaces
|
||||
parent: Features
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# Workspaces
|
||||
|
||||
Workspaces help you organize your social media accounts, especially if you manage multiple brands or clients.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Configuration
|
||||
parent: Getting Started
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
TryPost is configured through environment variables in the `.env` file.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: First Steps
|
||||
parent: Getting Started
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
After installing TryPost, follow these steps to start scheduling your social media posts.
|
||||
|
|
|
|||
9
docs/getting-started/index.md
Normal file
9
docs/getting-started/index.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Getting Started
|
||||
has_children: true
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
Get up and running with TryPost in minutes.
|
||||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Installation
|
||||
parent: Getting Started
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
This guide will walk you through installing TryPost on your server.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Platforms
|
||||
has_children: true
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
# Supported Platforms
|
||||
|
||||
TryPost supports the following social media platforms:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Bluesky
|
||||
parent: Platforms
|
||||
nav_order: 9
|
||||
---
|
||||
|
||||
# Bluesky
|
||||
|
||||
Connect your Bluesky account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Facebook
|
||||
parent: Platforms
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
# Facebook
|
||||
|
||||
Connect your Facebook pages to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Instagram
|
||||
parent: Platforms
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
# Instagram
|
||||
|
||||
Connect your Instagram Business or Creator account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: LinkedIn
|
||||
parent: Platforms
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# LinkedIn
|
||||
|
||||
Connect your LinkedIn profile or company pages to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Mastodon
|
||||
parent: Platforms
|
||||
nav_order: 10
|
||||
---
|
||||
|
||||
# Mastodon
|
||||
|
||||
Connect your Mastodon account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Pinterest
|
||||
parent: Platforms
|
||||
nav_order: 8
|
||||
---
|
||||
|
||||
# Pinterest
|
||||
|
||||
Connect your Pinterest account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Threads
|
||||
parent: Platforms
|
||||
nav_order: 7
|
||||
---
|
||||
|
||||
# Threads
|
||||
|
||||
Connect your Threads account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: TikTok
|
||||
parent: Platforms
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# TikTok
|
||||
|
||||
Connect your TikTok account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: X (Twitter)
|
||||
parent: Platforms
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# X (Twitter)
|
||||
|
||||
Connect your X (formerly Twitter) account to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: YouTube
|
||||
parent: Platforms
|
||||
nav_order: 6
|
||||
---
|
||||
|
||||
# YouTube
|
||||
|
||||
Connect your YouTube channel to TryPost.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Docker
|
||||
parent: Self-Hosting
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
# Docker Deployment
|
||||
|
||||
> **Coming Soon:** Docker support is planned but not yet available.
|
||||
|
|
|
|||
9
docs/self-hosting/index.md
Normal file
9
docs/self-hosting/index.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Self-Hosting
|
||||
has_children: true
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# Self-Hosting
|
||||
|
||||
Deploy TryPost on your own infrastructure.
|
||||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Production Setup
|
||||
parent: Self-Hosting
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# Production Setup
|
||||
|
||||
This guide covers deploying TryPost to a production environment.
|
||||
|
|
@ -76,6 +82,7 @@ ## Nginx Configuration
|
|||
|
||||
Example Nginx configuration:
|
||||
|
||||
{% raw %}
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
|
|
@ -122,6 +129,7 @@ ## Nginx Configuration
|
|||
client_max_body_size 100M;
|
||||
}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## SSL Certificate
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: Requirements
|
||||
parent: Self-Hosting
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# Server Requirements
|
||||
|
||||
This guide covers the requirements for self-hosting TryPost.
|
||||
|
|
|
|||
Loading…
Reference in a new issue