Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinDev committed Jan 18, 2021
1 parent 99066b9 commit 84bf5dd
Show file tree
Hide file tree
Showing 39 changed files with 51 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/architecture.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/tw.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/command.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/configuration.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/contribute.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/create-extension.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/editor.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/admin.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/conversation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/facebook.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/flat.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/page-scanner.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/page-update-notifier.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/static-generator.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/svg.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extension/template-editor.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/extension/version.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/extensions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/installation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/license.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/manage-assets.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/override-theme.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/roadmap.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/search.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/themes.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/upgrade.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions packages/docs/content/extension/version.md
@@ -1,11 +1,11 @@
---
title: "Page Versionning for Pushword CMS"
title: "Page Versioning for Pushword CMS"
h1: Version
toc: true
parent: extensions
---

Versionning pages with Pushword CMS.
Versioning pages with Pushword CMS.

## Install

Expand All @@ -32,4 +32,4 @@ Then you can switch from one or an other version (identified by it _h1_ and the

#### Does it work with [Flat](/extension/flat) ?

Yes, but you need to install admin extension to able to restore a previous version from a page. Else you can use a versionning tool like git.
Yes, but you need to install admin extension to able to restore a previous version from a page. Else you can use a Versioning tool like git.
2 changes: 1 addition & 1 deletion packages/docs/content/extensions.md
Expand Up @@ -24,6 +24,6 @@ parent: homepage
- [Template Editor](/extension/template-editor)
Edit view file online in the [admin](https://pushword.piedweb.com/extension/admin).
- [Version](/extension/version)
Versionning pages with Pushword CMS.
Versioning pages with Pushword CMS.

Add your own extension #[editing this file on github](https://github.com/Pushword/Pushword/edit/main/packages/docs/content/extensions.md).
6 changes: 3 additions & 3 deletions packages/docs/content/index.md
Expand Up @@ -17,16 +17,16 @@ prose: "max-w-screen-lg prose-sm md:prose-lg mx-auto p-3 prose dark:prose-light"
<li class="py-2"><strong>searchable</strong> : be findable on <strong class="text-white">google</strong> and other search engine</li>
<li class="py-2">build on top one of the most popular PHP framework <strong class="text-white">symfony</strong>. And you don’t need to know about it <strong class="text-white">to install Pushword</strong>.</li>
</ul>
<p class="hidden w-24 p-3 mt-3 font-bold text-center transform bg-white rounded shadow-md lg:block lg:-ml-10 -rotate-12 text-primary lg:-mb-3">Bonus</p>
<p class="py-3">With Pushword managing <strong class="text-white">multi-site</strong> and <strong class="text-white">internationalization</strong> is so simple.</p>
<p class="hidden w-24 p-3 mt-3 font-bold text-center transform bg-white rounded-lg shadow-md lg:block lg:-ml-10 -rotate-12 text-primary lg:-mb-3">Bonus</p>
<p class="py-3">With Pushword managing <strong class="text-white">multi-site</strong>, <strong class="text-white">internationalization</strong> and <strong>page vesioning</strong> is so simple.</p>
</div>
{% endapply %}

Want a demo ? This website is built with **Pushword** with flat file management, see the #[{{ svg('github') }} source code](https://github.com/Pushword/Pushword/tree/main/packages/docs).

See [how to install and test Pushword in less than one minute](/installation) :

{{ link('Get started', '/installation', {class: 'block text-center font-bold uppercase mx-auto p-3 text-white rotate-180 rounded bg-primary hover:opacity-75', 'style': 'max-width:200px'})|unprose }}
{{ link('Get started', '/installation', {class: 'block text-center font-bold uppercase mx-auto p-3 text-white rotate-180 rounded-lg bg-primary hover:opacity-75', 'style': 'max-width:200px'})|unprose }}

Or look at the detailled features or directly the #[source code](https://github.com/Pushword/pushword) (monorepo).

Expand Down
2 changes: 1 addition & 1 deletion packages/skeleton/public/assets/tw.css

Large diffs are not rendered by default.

Expand Up @@ -16,12 +16,16 @@
</div>
<nav class="nav">
<ul class="flex space-x-1">
{% set nav_item_class = 'font-bold px-3 py-4 rounded text-primary hover:bg-primary hover:bg-opacity-75 hover:text-white transition-colors duration-200' %}
<li><a class="hidden px-3 py-4 font-bold text-white transition-colors duration-200 bg-blue-500 rounded md:inline-block hover:bg-opacity-75" href="{{ page('installation') }}">Get Started</a></li>
{% set nav_item_class = 'font-bold px-3 py-4 rounded-lg text-primary hover:bg-primary hover:bg-opacity-75 hover:text-white transition-colors duration-200' %}
<li><a class="{{ nav_item_class }} inline-block" href="{{ page('installation') }}">Docs</a></li>
<li><a class="hidden md:inline-block {{ nav_item_class }}" href="{{ page('extension') }}">Extensions</a></li>
<li><a class="hidden md:inline-block {{ nav_item_class }}" href="{{ page('extensions') }}">Extensions</a></li>
<li><a class="hidden md:inline-block {{ nav_item_class }}" href="{{ page('contribute') }}">Contribute</a></li>
<li><a class="hidden md:inline-block {{ nav_item_class }}" href="{{ page('roadmap') }}">Roadmap</a></li>
{% if page.slug == 'homepage' %}
<li><a
class="hidden px-3 py-4 font-bold text-white transition-colors duration-200 bg-blue-500 rounded-lg md:inline-block hover:bg-opacity-75"
href="{{ page('installation') }}">Get Started</a></li>
{% endif %}
</ul>
</nav>
</div>
Expand Down
Expand Up @@ -14,7 +14,7 @@
<span class="block w-full h-1 border-b-2 border-gray-100"></span>
</div>
</label>
<div id="right-column-nav" class="sticky z-40 h-full px-1 py-6 mr-24 overflow-hidden text-sm bg-white border-r border-gray-200 w-60 lg:block lg:top-18 lg:mr-3 dark:bg-gray-900 dark:border-gray-700">
<div id="right-column-nav" class="sticky z-40 h-full py-6 pl-1 pr-3 mr-24 overflow-hidden text-sm bg-white border-r border-gray-200 w-60 lg:block lg:top-18 lg:mr-3 dark:bg-gray-900 dark:border-gray-700">
{% set heading_class = 'block px-3 mb-3 text-sm font-semibold tracking-wide text-gray-900 dark:text-gray-100 uppercase lg:mb-3 lg:text-xs mt-3' %}
{% set link_class = 'block px-3 py-2 transition-colors duration-200 relative hover:text-white hover:bg-primary hover:bg-opacity-75 text-gray-900 dark:text-gray-100 rounded' %}
{% for n in nav %}
Expand Down
2 changes: 1 addition & 1 deletion packages/version/README.md
@@ -1,6 +1,6 @@
# Version

Versionning pages with Pushword CMS.
Versioning pages with Pushword CMS.

[![Latest Version](https://img.shields.io/github/tag/pushword/pushword.svg?style=flat&label=release)](https://github.com/Pushword/Pushword/tags)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE)
Expand Down
2 changes: 1 addition & 1 deletion packages/version/composer.json
@@ -1,7 +1,7 @@
{
"name": "pushword/version-file",
"type": "symfony-bundle",
"description": "Versionning pages with Pushword CMS.",
"description": "Versioning pages with Pushword CMS.",
"keywords": [],
"homepage": "https://pushword.piedweb.com/extension/version",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion packages/version/src/VersionController.php
Expand Up @@ -40,7 +40,7 @@ public function loadVersion(string $id, string $version): Response
return $this->redirectToRoute('admin_app_page_edit', ['id' => $id]);
}

public function resetVersionning(string $id): Response
public function resetVersioning(string $id): Response
{
$this->versionner->reset($id);

Expand Down
2 changes: 1 addition & 1 deletion packages/version/src/VersionRoutes.yaml
@@ -1,6 +1,6 @@
piedweb_version_reset:
path: /admin/version/{id}/reset
controller: Pushword\Version\VersionController::resetVersionning
controller: Pushword\Version\VersionController::resetVersioning
methods: [GET]

piedweb_version_list:
Expand Down
4 changes: 2 additions & 2 deletions packages/version/tests/VersionTest.php
Expand Up @@ -21,9 +21,9 @@ public function testIt(): void

$page = $repo->findOneBy(['id' => 1]);

$page->setH1('edited title to test versionning');
$page->setH1('edited title to test Versioning');
$em->flush();
$page->setH1('edited title to test versionning the second time');
$page->setH1('edited title to test Versioning the second time');
$em->flush();

$versionner = new Versionner(
Expand Down

0 comments on commit 84bf5dd

Please sign in to comment.