diff --git a/docs/README.md b/docs/README.md index c35aebde..dfb280b4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/_config.yml b/docs/_config.yml index f4a9ada2..ae42fa76 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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 FSL License." + +# Back to top link +back_to_top: true +back_to_top_text: "Back to top" # Exclude files exclude: diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 00000000..db7f9e42 Binary files /dev/null and b/docs/assets/images/logo.png differ diff --git a/docs/contributing.md b/docs/contributing.md index c4e513b6..4712f768 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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. diff --git a/docs/features/index.md b/docs/features/index.md new file mode 100644 index 00000000..e79ab3ee --- /dev/null +++ b/docs/features/index.md @@ -0,0 +1,9 @@ +--- +title: Features +has_children: true +nav_order: 4 +--- + +# Features + +Learn about TryPost's powerful features. diff --git a/docs/features/scheduling.md b/docs/features/scheduling.md index c0cb2919..ed0f88f1 100644 --- a/docs/features/scheduling.md +++ b/docs/features/scheduling.md @@ -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. diff --git a/docs/features/team.md b/docs/features/team.md index b4cee4b9..29e9ab67 100644 --- a/docs/features/team.md +++ b/docs/features/team.md @@ -1,3 +1,9 @@ +--- +title: Team Management +parent: Features +nav_order: 3 +--- + # Team Management Invite team members to collaborate on your social media content. diff --git a/docs/features/workspaces.md b/docs/features/workspaces.md index 07ccc797..b4eb3131 100644 --- a/docs/features/workspaces.md +++ b/docs/features/workspaces.md @@ -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. diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index d68e171e..26788d0e 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -1,3 +1,9 @@ +--- +title: Configuration +parent: Getting Started +nav_order: 2 +--- + # Configuration TryPost is configured through environment variables in the `.env` file. diff --git a/docs/getting-started/first-steps.md b/docs/getting-started/first-steps.md index 81624455..53058ba3 100644 --- a/docs/getting-started/first-steps.md +++ b/docs/getting-started/first-steps.md @@ -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. diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md new file mode 100644 index 00000000..23d48281 --- /dev/null +++ b/docs/getting-started/index.md @@ -0,0 +1,9 @@ +--- +title: Getting Started +has_children: true +nav_order: 2 +--- + +# Getting Started + +Get up and running with TryPost in minutes. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index efa46c05..8bb96448 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,3 +1,9 @@ +--- +title: Installation +parent: Getting Started +nav_order: 1 +--- + # Installation This guide will walk you through installing TryPost on your server. diff --git a/docs/platforms/README.md b/docs/platforms/README.md index f953f818..10888f8e 100644 --- a/docs/platforms/README.md +++ b/docs/platforms/README.md @@ -1,3 +1,9 @@ +--- +title: Platforms +has_children: true +nav_order: 3 +--- + # Supported Platforms TryPost supports the following social media platforms: diff --git a/docs/platforms/bluesky.md b/docs/platforms/bluesky.md index 81eed521..d8a418ef 100644 --- a/docs/platforms/bluesky.md +++ b/docs/platforms/bluesky.md @@ -1,3 +1,9 @@ +--- +title: Bluesky +parent: Platforms +nav_order: 9 +--- + # Bluesky Connect your Bluesky account to TryPost. diff --git a/docs/platforms/facebook.md b/docs/platforms/facebook.md index c6a0b7fb..1d404cd3 100644 --- a/docs/platforms/facebook.md +++ b/docs/platforms/facebook.md @@ -1,3 +1,9 @@ +--- +title: Facebook +parent: Platforms +nav_order: 3 +--- + # Facebook Connect your Facebook pages to TryPost. diff --git a/docs/platforms/instagram.md b/docs/platforms/instagram.md index d18afff7..17890c02 100644 --- a/docs/platforms/instagram.md +++ b/docs/platforms/instagram.md @@ -1,3 +1,9 @@ +--- +title: Instagram +parent: Platforms +nav_order: 4 +--- + # Instagram Connect your Instagram Business or Creator account to TryPost. diff --git a/docs/platforms/linkedin.md b/docs/platforms/linkedin.md index 291d1bd2..5bf66987 100644 --- a/docs/platforms/linkedin.md +++ b/docs/platforms/linkedin.md @@ -1,3 +1,9 @@ +--- +title: LinkedIn +parent: Platforms +nav_order: 1 +--- + # LinkedIn Connect your LinkedIn profile or company pages to TryPost. diff --git a/docs/platforms/mastodon.md b/docs/platforms/mastodon.md index 75ed4bcb..f2ec609c 100644 --- a/docs/platforms/mastodon.md +++ b/docs/platforms/mastodon.md @@ -1,3 +1,9 @@ +--- +title: Mastodon +parent: Platforms +nav_order: 10 +--- + # Mastodon Connect your Mastodon account to TryPost. diff --git a/docs/platforms/pinterest.md b/docs/platforms/pinterest.md index 584054a5..f309823f 100644 --- a/docs/platforms/pinterest.md +++ b/docs/platforms/pinterest.md @@ -1,3 +1,9 @@ +--- +title: Pinterest +parent: Platforms +nav_order: 8 +--- + # Pinterest Connect your Pinterest account to TryPost. diff --git a/docs/platforms/threads.md b/docs/platforms/threads.md index 3be8784c..6721dc04 100644 --- a/docs/platforms/threads.md +++ b/docs/platforms/threads.md @@ -1,3 +1,9 @@ +--- +title: Threads +parent: Platforms +nav_order: 7 +--- + # Threads Connect your Threads account to TryPost. diff --git a/docs/platforms/tiktok.md b/docs/platforms/tiktok.md index 7573a265..7ca7a551 100644 --- a/docs/platforms/tiktok.md +++ b/docs/platforms/tiktok.md @@ -1,3 +1,9 @@ +--- +title: TikTok +parent: Platforms +nav_order: 5 +--- + # TikTok Connect your TikTok account to TryPost. diff --git a/docs/platforms/x-twitter.md b/docs/platforms/x-twitter.md index 87da1475..f46cec4f 100644 --- a/docs/platforms/x-twitter.md +++ b/docs/platforms/x-twitter.md @@ -1,3 +1,9 @@ +--- +title: X (Twitter) +parent: Platforms +nav_order: 2 +--- + # X (Twitter) Connect your X (formerly Twitter) account to TryPost. diff --git a/docs/platforms/youtube.md b/docs/platforms/youtube.md index 6b917f75..fa213b9f 100644 --- a/docs/platforms/youtube.md +++ b/docs/platforms/youtube.md @@ -1,3 +1,9 @@ +--- +title: YouTube +parent: Platforms +nav_order: 6 +--- + # YouTube Connect your YouTube channel to TryPost. diff --git a/docs/self-hosting/docker.md b/docs/self-hosting/docker.md index a3ecbd41..78ccf808 100644 --- a/docs/self-hosting/docker.md +++ b/docs/self-hosting/docker.md @@ -1,3 +1,9 @@ +--- +title: Docker +parent: Self-Hosting +nav_order: 3 +--- + # Docker Deployment > **Coming Soon:** Docker support is planned but not yet available. diff --git a/docs/self-hosting/index.md b/docs/self-hosting/index.md new file mode 100644 index 00000000..bc7fdc13 --- /dev/null +++ b/docs/self-hosting/index.md @@ -0,0 +1,9 @@ +--- +title: Self-Hosting +has_children: true +nav_order: 5 +--- + +# Self-Hosting + +Deploy TryPost on your own infrastructure. diff --git a/docs/self-hosting/production.md b/docs/self-hosting/production.md index 0aa10e91..e09b975e 100644 --- a/docs/self-hosting/production.md +++ b/docs/self-hosting/production.md @@ -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 diff --git a/docs/self-hosting/requirements.md b/docs/self-hosting/requirements.md index 829e9fb2..a99ef438 100644 --- a/docs/self-hosting/requirements.md +++ b/docs/self-hosting/requirements.md @@ -1,3 +1,9 @@ +--- +title: Requirements +parent: Self-Hosting +nav_order: 1 +--- + # Server Requirements This guide covers the requirements for self-hosting TryPost.