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 bdcd848 commit 20ce58f
Show file tree
Hide file tree
Showing 45 changed files with 559,308 additions and 100 deletions.
2 changes: 1 addition & 1 deletion docs/architecture.html

Large diffs are not rendered by default.

16,691 changes: 16,689 additions & 2 deletions docs/assets/app.js

Large diffs are not rendered by default.

262,900 changes: 262,899 additions & 1 deletion docs/assets/tw.css

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/command.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/configuration.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions 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.

4 changes: 2 additions & 2 deletions 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.

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

Large diffs are not rendered by default.

34 changes: 34 additions & 0 deletions docs/extension/conversation.html

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/extension/page-scanner.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/extension/page-update-notifier.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/extension/static-generator.html

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/extension/template-editor.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/feed.xml
@@ -1 +1 @@
<rss xmlns:dc=http://purl.org/dc/elements/1.1/ xmlns:atom=http://www.w3.org/2005/Atom version=2.0><channel><title>Pushword - Modern CMS to build rapidly Websites (powered by Symfony)</title> <link>https://pushword.piedweb.com/ <description></description> <link href=https://pushword.piedweb.com/feed.xml rel=self type=application/rss+xml> <item><title></title> <link>https://pushword.piedweb.com/architecture <guid>https://pushword.piedweb.com/architecture</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/command <guid>https://pushword.piedweb.com/command</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/configuration <guid>https://pushword.piedweb.com/configuration</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/contribute <guid>https://pushword.piedweb.com/contribute</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/create-extension <guid>https://pushword.piedweb.com/create-extension</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item></channel> </rss>
<rss xmlns:dc=http://purl.org/dc/elements/1.1/ xmlns:atom=http://www.w3.org/2005/Atom version=2.0><channel><title>Pushword - Modern CMS to build rapidly Websites (powered by Symfony)</title> <link>https://pushword.piedweb.com/ <description></description> <link href=https://pushword.piedweb.com/feed.xml rel=self type=application/rss+xml> <item><title></title> <link>https://pushword.piedweb.com/extension/conversation <guid>https://pushword.piedweb.com/extension/conversation</guid> <pubdate>Mon, 18 Jan 2021 10:23:41 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/architecture <guid>https://pushword.piedweb.com/architecture</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/command <guid>https://pushword.piedweb.com/command</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/configuration <guid>https://pushword.piedweb.com/configuration</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item> <item><title></title> <link>https://pushword.piedweb.com/contribute <guid>https://pushword.piedweb.com/contribute</guid> <pubdate>Sun, 17 Jan 2021 19:16:07 +0100</pubdate></item></channel> </rss>
2 changes: 1 addition & 1 deletion docs/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions 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.

4 changes: 2 additions & 2 deletions 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.

1 change: 1 addition & 0 deletions docs/sitemap.txt
@@ -1,3 +1,4 @@
https://pushword.piedweb.com/extension/conversation
https://pushword.piedweb.com/architecture
https://pushword.piedweb.com/command
https://pushword.piedweb.com/configuration
Expand Down
4 changes: 4 additions & 0 deletions docs/sitemap.xml
@@ -1,5 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>https://pushword.piedweb.com/extension/conversation</loc>
<lastmod>2021-01-18</lastmod>
</url>
<url>
<loc>https://pushword.piedweb.com/architecture</loc>
<lastmod>2021-01-17</lastmod>
Expand Down
2 changes: 1 addition & 1 deletion docs/themes.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/upgrade.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/core/src/templates/page/_footer.html.twig
@@ -1,4 +1,4 @@
<footer class="text-sm border-t border-gray-200 dark:border-gray-700">
<footer class="{{ footer_class|default('text-sm border-t border-gray-200 dark:border-gray-700') }}">
<div class="max-w-screen-md p-3 py-10 mx-auto text-right">
{% block footer %}
{% include view('/component/alternate_links.html.twig') %}
Expand Down
3 changes: 3 additions & 0 deletions packages/docs/assets/package.json
Expand Up @@ -29,5 +29,8 @@
"dev": "encore dev",
"watch": "encore dev --watch",
"build": "encore production"
},
"dependencies": {
"tailwindcss-hero-patterns": "^0.0.1"
}
}
4 changes: 4 additions & 0 deletions packages/docs/assets/tailwind.config.js
Expand Up @@ -32,6 +32,9 @@ module.exports = {
textDecoration: "none",
fontWeight: 400,
},
"ul > li::before": {
backgroundColor: theme("colors.gray.600"),
},
color: "#333",
a: {
color: "var(--secondary)",
Expand Down Expand Up @@ -80,6 +83,7 @@ module.exports = {
color: theme("colors.gray.400"),
},
code: {
backgroundColor: theme("colors.gray.600"),
color: theme("colors.gray.100"),
},
"a code": {
Expand Down
39 changes: 19 additions & 20 deletions packages/docs/content/index.md
@@ -1,29 +1,28 @@
---
title: Pushword - Modern CMS to build rapidly Websites (powered by Symfony)
h1: Build modern websites rapidly <br> <span class="text-primary">maintain it as quickly</span>
h1: <span class="block mt-6 leading-relaxed">Build modern <em class="font-light">Content First</em> websites rapidly <br> <span class="text-primary dark:text-white">Manage and maintain it as quickly</span></span>
name: Pushword
template: /page/homepage.html.twig
prose: "max-w-screen-lg prose-lg mx-auto p-3 prose dark:prose-light"
prose: "max-w-screen-lg prose-sm md:prose-lg mx-auto p-3 prose dark:prose-light"
---

<div class="p-3 text-xl bg-yellow-50 text-secondary rounded-xl" markdown=1>

Puswhord is a **PHP** <strong style="color:var(--primary)">CMS</strong> to <strong style="color:var(--primary)">rapidly</strong> create, manage and maintain <strong style="color:var(--primary)">extandable Website(s)</strong>.

It's

- easily _editable_ via <strong style="color:var(--primary)">flat files</strong> or <strong style="color:var(--primary)">full featured admin</strong>
- fully _configurable_ and _customizable_ : configure it via one config file in _yaml_ and edit the default theme built with <strong style="color:var(--primary)">Tailwind</strong> in a second
- **searchable** : be findable on <strong style="color:var(--primary)">google</strong> and other search engine
- build on top one of the most popular PHP framework <strong style="color:var(--primary)">symfony</strong>. And you don't need to know about it <strong style="color:var(--primary)">to install Pushword</strong>.

<p class="text-center"><strong class="inline-block p-3 -mb-3 rotate-180 bg-yellow-100 rounded shadow-md" style="color:var(--primary)">Bonus</strong> </p>

With Pushword managing <strong style="color:var(--primary)">multi-site</strong> and <strong style="color:var(--primary)">internationalization</strong> is so simple.

</div>

Want a demo ? This website is built with **Pushword**.
{% apply unprose %}

<div class="max-w-screen-lg p-3 mx-auto mb-6 text-xl md:p-6 bg-gradient-to-br from-yellow-500 to-yellow-600 text-yellow-50 text-secondary rounded-xl">
<p class="py-3">Puswhord is a PHP <strong class="text-white">CMS</strong> to <strong class="text-white">rapidly</strong> create, manage and maintain <strong class="text-white">extandable Website(s)</strong>.</p>
<p class="py-3">It’s</p>
<ul class="list-disc list-inside">
<li class="py-2">easily <em>editable</em> via <strong class="text-white">flat files</strong> or <strong class="text-white">full featured admin</strong></li>
<li class="py-2">fully <em>configurable</em>, <em>customizable</em> and <em>extandable</em>. <strong>Configure it</strong> via one config file in <em>yaml</em>, edit the default theme built with <strong class="text-white">Tailwind</strong> in an instant, extend it with <a href="/extension">extension</a></li>
<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>
</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) :

Expand Down
1 change: 1 addition & 0 deletions packages/docs/content/roadmap.md
Expand Up @@ -10,6 +10,7 @@ parent: contribute
- release de sonata 4
- Test installer
- Issue : User Password Edit don't work from admin
- Issue : preview not working

## TODO Extension

Expand Down
2 changes: 1 addition & 1 deletion packages/flat/src/Importer/PageImporter.php
Expand Up @@ -54,7 +54,7 @@ private function getContentDir()

public function import(string $filePath, DateTimeInterface $lastEditDatetime): void
{
if ('text/plain' != finfo_file(finfo_open(\FILEINFO_MIME_TYPE), $filePath)) {
if (strpos(finfo_file(finfo_open(\FILEINFO_MIME_TYPE), $filePath), 'text/') !== 0) {
return;
}

Expand Down
22 changes: 10 additions & 12 deletions packages/installer/src/installer
Expand Up @@ -3,7 +3,6 @@
# Use it :
# ./installer ./my-folder

# Bash script relative lines
: ${1?failure: in wich folder should i work ?}
folder=$1
echo "Installation running in folder $folder"
Expand Down Expand Up @@ -61,27 +60,26 @@ php bin/console assets:install --symlink --relative -q

mkdir public/build && echo -e "{}" >public/build/manifest.json


# Do some cleaning
rm package.json
rm -rf assets
cp vendor/pushword/skeleton/assets assets

sed -i -e '/"Pushword\\\\\Installer\\\\PostInstall::postPackageInstall"/d' composer.json
sed -i -e '/"Pushword\\\\\Installer\\\\PostInstall::beforeCacheClear",/d' composer.json
composer remove pushword/installer pushword/skeleton -q

# Install recommended extension
read -p "Install recommended extensions (admin, page-scanner, static-generator, svg, template-editor) ? [Y/n] " -n 1 -r
if [[ $REPLY =~ ^[Yy]$ ]]
then
composer require pushword/admin pushword/page-scanner pushword/static-generator pushword/svg pushword/template-editor
composer require pushword/admin pushword/page-scanner pushword/static-generator pushword/svg pushword/template-editor -q
sed -i '1s/^/page_scanner:\n resource: "@PushwordPageScannerBundle\/PageScannerRoutes.yaml"\n/' config/routes.yaml
sed -i '1s/^/static:\n resource: "@PushwordStaticGeneratorBundle\/StaticRoutes.yaml"\n/' config/routes.yaml
sed -i '1s/^/template_editor:\n resource: "@PushwordTemplateEditorBundle\/TemplateEditorRoutes.yaml"\n/' config/routes.yaml
sed -i '1s/^/admin:\n resource: "@PushwordAdminBundle\/AdminRoutes.yaml"\n/' config/routes.yaml
fi

# Do some cleaning
rm package.json
rm -rf assets
cp -r vendor/pushword/skeleton/assets assets

sed -i -e '/"Pushword\\\\\Installer\\\\PostInstall::postPackageInstall"/d' composer.json
sed -i -e '/"Pushword\\\\\Installer\\\\PostInstall::beforeCacheClear",/d' composer.json
composer remove pushword/installer pushword/skeleton -q

# Launch Server and Play
read -p "Launch Server and play? [Y/n] " -n 1 -r
if [[ $REPLY =~ ^[Yy]$ ]]
Expand Down
16,691 changes: 16,689 additions & 2 deletions packages/skeleton/public/assets/app.js

Large diffs are not rendered by default.

262,900 changes: 262,899 additions & 1 deletion packages/skeleton/public/assets/tw.css

Large diffs are not rendered by default.

Expand Up @@ -6,7 +6,6 @@

{% block content %}

<div class="pt-3"></div>
{% if page.raw is not null %}
{{ page.content.body|raw }}
{% elseif page.toc is not null %}
Expand All @@ -22,7 +21,7 @@

{% if page.content.toc is not empty %}
<div class="order-3 w-full overflow-hidden lg:order-2 lg:w-1/5">
<div class="max-w-screen-sm p-2 pt-4 m-2 rounded shadow-md bg-gray-50 dark:border-gray-700 lg:max-w-xs lg:absolute">
<div class="max-w-screen-sm p-3 pt-4 m-2 rounded shadow-inner bg-gray-50 dark:border-gray-700 lg:max-w-xs lg:absolute">
<h3 class="block px-1 mb-3 text-sm font-semibold tracking-wide text-gray-900 uppercase dark:text-gray-100 lg:mb-3 lg:text-xs">Contents</h3>
<div class="px-1 -ml-6 prose-sm dark:prose-light max-w-none">
{{ page.content.toc|raw }}
Expand Down
@@ -1,25 +1,25 @@
<header class="fixed top-0 left-0 right-0 z-50 flex flex-col">
<div class="flex flex-row items-center justify-between p-4 bg-white border-b border-gray-200 dark:bg-gray-900 dark:border-gray-700">
<div class="flex flex-row items-center justify-between p-4 border-b shadow-sm border-gray-50 bg-gray-50 dark:bg-gray-900 dark:border-gray-700">
<span class="block mr-1 font-mono text-4xl">
<a class="flex font-bold logo text-primary hover:text-primary" href="{{ homepage() }}">
<span style="background-image:url('/assets/logo.svg')" class="inline-block w-12 h-12 bg-center bg-contain fill-current text-primary"></span>
<span class="hidden mt-2 ml-2 text-small lg:inline-block">{{ app_name }}</span>
</a>
</span>
<div class="flex flex-row flex-1 mx-3 md:mx-6">
<input type="text" id="search" placeholder="Search" class="w-20 px-2 py-1 text-xl border-none rounded md:rounded-r-none md:rounded-l-lg md:w-full focus:w-60 md:focus:w-full focus:shadow-none focus:outline-none focus:border-none bg-gray-50 dark:bg-gray-700">
<button class="hidden px-4 py-4 font-bold text-white rounded-r-lg bg-primary md:block hover:opacity-75" onclick="document.querySelector('#search').focus()">
<input type="text" id="search" placeholder="Search" class="w-20 px-2 py-1 text-xl bg-white border-2 border-white rounded rounded-r-none outline-none md:rounded-l-lg md:w-full focus:w-60 md:focus:w-full focus:border-primary dark:bg-gray-700">
<button class="px-4 py-4 font-bold text-white rounded-r-lg bg-primary md:block hover:opacity-75" onclick="document.querySelector('#search').focus()">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" viewBox="0 0 16 16">
<path d="M11.742 10.344a6.5 6.5 0 1 0-1.397 1.398h-.001c.03.04.062.078.098.115l3.85 3.85a1 1 0 0 0 1.415-1.414l-3.85-3.85a1.007 1.007 0 0 0-.115-.1zM12 6.5a5.5 5.5 0 1 1-11 0 5.5 5.5 0 0 1 11 0z"/>
</svg>
</button>
</div>
<nav class="nav">
<ul class="flex space-x-1">
{% set nav_item_class = 'px-3 py-4 rounded text-primary hover:bg-primary hover:bg-opacity-75 hover:text-white transition-colors duration-200' %}
{% 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 md:inline-block {{ nav_item_class }}" href="{{ page('installation') }}">Getting Started</a></li>
<li><a class="{{ nav_item_class }} inline-block" href="{{ page('themes') }}">Themes</a></li>
<li><a class="{{ nav_item_class }} inline-block" href="{{ page('extension') }}">Extensions</a></li>
<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('contribute') }}">Contribute</a></li>
<li><a class="hidden md:inline-block {{ nav_item_class }}" href="{{ page('roadmap') }}">Roadmap</a></li>
</ul>
Expand All @@ -37,4 +37,4 @@
:root {
--tw-ring-color: transparent;
}
</style>
</style>
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-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">
<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">
{% 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
@@ -1,15 +1,8 @@
{% extends view('/page/page_default.html.twig') %}

{% block html_opener %}
<html
lang="{{ page.locale|default(apps.get().defaultLocale) }}"
{{ mergeAttr({'class': 'leading-tight text-gray-900 dark:bg-gray-900 dark:text-gray-100'}, page.htmlOpenerAttr|default({})) }}
>
{% endblock %}

{% block content %}
<div class="flex flex-wrap items-stretch max-w-screen-xl mx-auto">

<div class="flex flex-wrap items-stretch">

<div class="order-2 w-full mx-auto lg:mr-0 lg:ml-0">
{% include view('/page/_content.html.twig') %}
Expand Down
Expand Up @@ -23,11 +23,12 @@
] %}

{% set breadcrumb_class = 'p-3 text-sm font-light text-gray-700 dark:text-gray-300' %}
{% set footer_class = 'text-sm border-t border-yellow-50 dark:border-gray-700 bg-gray-50 dark:bg-gray-900 shadow-inner shadow-sm' %}

{% block html_opener %}
<html
lang="{{ page.locale|default(apps.get().defaultLocale) }}"
{{ mergeAttr({'class': 'leading-tight text-gray-900 dark:bg-gray-900 dark:text-gray-100'}, page.htmlOpenerAttr|default({})) }}
{{ mergeAttr({'class': 'leading-tight text-gray-900 bg-white dark:bg-gray-900 dark:text-gray-100'}, page.htmlOpenerAttr|default({})) }}
>
{% endblock %}

Expand All @@ -37,6 +38,7 @@


<div class="order-2 w-full mx-auto lg:mr-0 lg:ml-0 lg:w-3/4">
<div class="pt-6"></div>
{% include view('/page/_breadcrumb.html.twig') %}
{% include view('/page/_content.html.twig') %}
</div>
Expand Down

0 comments on commit 20ce58f

Please sign in to comment.