Skip to content

Commit

Permalink
complete docs sections, update branding
Browse files Browse the repository at this point in the history
  • Loading branch information
sheadawson committed Oct 17, 2024
1 parent 20aaa7e commit 40433a9
Show file tree
Hide file tree
Showing 18 changed files with 261 additions and 327 deletions.
19 changes: 7 additions & 12 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,12 @@ export default defineConfig({
description: "Revisor is a robust versioning and publishing system for Laravel Eloquent Models.",
cleanUrls: true,
themeConfig: {
logo: {
light: '/assets/slice1blight.svg',
dark: '/assets/slice1bdark.svg',
},
siteTitle: false,
// logo: {
// light: '/assets/ic_logo_landscape.svg',
// dark: '/assets/ic_logo_landscape_dark.svg',
// },
siteTitle: 'Laravel Revisor',
// https://vitepress.dev/reference/default-theme-config
nav: [
{text: "IndraCollective", link: "https://indracollective.dev"},
// {text: "Home", link: "/"},
// {text: "Docs", link: "/introduction"},
// { text: "Support Us", link: "https://indracollective.dev/support" },
],

sidebar: [
{
Expand Down Expand Up @@ -46,13 +40,14 @@ export default defineConfig({
{text: "FilamentPHP", link: "/filament-php"},
],
},
{text: "IndraCollective", link: "https://indracollective.dev"},
],
},
],

socialLinks: [
{icon: "github", link: "https://github.com/indracollective/laravel-revisor"},
{icon: "twitter", link: "https://twitter.com/livesourcenz"},
{icon: "twitter", link: "https://x.com/indracollective"},
],
footer: {
message: "Released under the MIT License.",
Expand Down
94 changes: 77 additions & 17 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -1,26 +1,86 @@
:root {
--vp-c-brand-1: #a45af8;
--vp-c-brand-2: #b778ff;
--vp-c-brand-3: #a45af8;
--vp-c-bg-soft: #f0f2fc;
--vp-button-alt-bg: #f0f2fc;
--vp-button-alt-hover-bg: #f2f5f8;
--vp-c-brand-1: #22c55e;
--vp-c-brand-2: #4ade80;
--vp-c-brand-3: #16a34a;
--vp-c-text-1: #1e293b;
--vp-c-text-2: #475569;
--vp-c-text-3: #64748b;

--vp-c-bg: #ffffff;
--vp-c-bg-soft: #f1f5f9;
--vp-c-bg-alt: #e2e8f0;

--vp-button-brand-bg: var(--vp-c-brand-1);
--vp-button-brand-hover-bg: var(--vp-c-brand-3);
--vp-button-brand-active-bg: var(--vp-c-brand-3);

--vp-button-alt-bg: var(--vp-c-bg-soft);
--vp-button-alt-hover-bg: var(--vp-c-bg-alt);

--vp-sidebar-bg-color: var(--vp-c-bg-soft);

}

.dark {
--vp-c-bg: #020617;
--vp-c-bg-soft: #0a0e1f;
--vp-c-bg-alt: #01020e;
--vp-button-alt-bg: #0a0e1f;
--vp-button-alt-hover-bg: #1b2240;
--vp-c-text-1: #f1f5f9;
--vp-c-text-2: #94a3b8;
--vp-c-text-3: #64748b;

--vp-c-bg: #0F1829;
--vp-c-bg-soft: #1e293b;
--vp-c-bg-alt: #1b2333;

--vp-sidebar-bg-color: var(--vp-c-bg-soft);

--vp-c-border: #334155;
--vp-c-divider: #334155;
--vp-c-gutter: #1e293b;

}

.tagline {
color: var(--vp-c-text-1) !important;
}

.VPNavBar.home .title {
width: 150px;
color: transparent !important;
background-image: url('/assets/ic_logo_landscape.svg');
background-size: contain;
background-repeat: no-repeat;
background-position: center;
}

.dark .VPNavBar.home .title {
background-image: url('/assets/ic_logo_landscape_dark.svg');
}

.VPSidebarItem.level-1.is-link {
position: fixed;
bottom: 0;
left: 0;
right: 0;
background-color: var(--vp-c-bg-soft);
padding: 16px 0;
border-top: 1px solid var(--vp-c-divider);
}

.VPSidebarItem.level-1.is-link a {
width: 100%;
height: 100%;
background-image: url('/assets/ic_logo_landscape.svg');
background-repeat: no-repeat;
background-position: center;
}

.dark .VPSidebarItem.level-1.is-link a {
background-image: url('/assets/ic_logo_landscape_dark.svg');
}

.VPHomeHero .text {
font-size: 32px;
.VPSidebarItem.level-1.is-link a:after {
display: none;
}

@media (min-width: 640px) {
.VPHomeHero .text {
font-size: 50px;
}
.VPSidebarItem.level-1.is-link p {
margin-left: -10000px;
}
19 changes: 19 additions & 0 deletions docs/assets/ic_logo_landscape.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions docs/assets/ic_logo_landscape_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions docs/assets/slice1bdark.svg

This file was deleted.

12 changes: 0 additions & 12 deletions docs/assets/slice1blight.svg

This file was deleted.

2 changes: 1 addition & 1 deletion docs/filament-php.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FilamentPHP

## Published Status Table Column
A Revisor FilamentPHP plugin is currently under development. Follow us on [X/Twitter](https://twitter.com/indracollective) for updates.

9 changes: 4 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ layout: home

hero:
name: "Laravel Revisor"
text: "By IndraCollective"
tagline: "Robust Draft, Publishing and Versioning\nfor Laravel Eloquent Models."
actions:
- theme: brand
Expand All @@ -16,9 +15,9 @@ hero:

features:
- title: Seamless Database Design
details: Separate, complete database tables for Draft, Published and Version history records per Eloquent Model, reducing exposure to the added complexity of context-dependent records
- title: Intuitive API
details: Super simple, feature complete API for Publishing and Versioning records, including Version rollbacks, pruning and more.
details: Separate, complete database tables for Draft, Published and Version history records per Eloquent Model.
- title: Beautiful API
details: Everything you need to manage Publishing and Versioning records including Version rollbacks, pruning and more in a simple and intuitive API.
- title: Flexible Context Management
details: Easily switch between Draft, Published and Version contexts at any level including Global Config, Route Middleware, Query Scopes and context-isolating Closures.
details: Easily move between Draft, Published and Version contexts at any level; Global Config, Route Middleware, Query Scopes and more.
---
Loading

0 comments on commit 40433a9

Please sign in to comment.