getkirby / getkirby.com

Source code and content for the Kirby website

Kirby website

This repo contains the whole <getkirby.com> website.

Requirements

Local development server running PHP 8.1+ (e.g. Apache, nginx, MAMP).

Installation and setup

Clone the repo into an empty folder

git clone [email protected]:getkirby/getkirby.com.git

Metadata for search engines and social media

See site/plugins/meta/README.md for further information.

getkirby.com's Issues

Signature of Template Components

It seems like the signature of core components changed. The docs currently feature this example:

class CustomTemplate extends Kirby\Cms\Template {

}

Kirby::plugin('your/plugin', [
    'components' => [
        'template' => function (App $kirby, string $name, array $data = [], string $contentType = null) {
            return new CustomTemplate($name, $data, $contentType);
        }
    ]
]);

It should be like this instead:

class CustomTemplate extends Kirby\Cms\Template {

}

Kirby::plugin('your/plugin', [
    'components' => [
        'template' => function (App $kirby, string $name, string $contentType = null) {
            return new CustomTemplate($name, $contentType);
        }
    ]
]);

$data is now directly passed to the render function as a variable.

Sticky navigation in cheatsheet

It would be helpful if a nav with jump marks to the different content sections existed. Similar to the navigation in the guides but sticky.

Missing documentation for `sortable` option of pages sections

Changelog for crucial/breaking changes from v2 to v3

@jenstornell:

Maybe you are already doing it, but on release I think most of us would need a really big changelog of every function that has changed in behavior, name or arguments.

The most important for this changelog is the core I think, because it will probably be hard to spot the changes right away. There seems to be many small changes here and there.

Because the panel is completely rewritten I don't find the changelog as important there. In the panel case I think pure docs will be the most helpful. Maybe hooks is the only feature that stick around from Kirby 2.

There will be content changes as well, especially when it comes to naming of files. Also if there was a change in how/where images will be stored.

Cache concept

https://www.notion.so/getkirby/Cache-Concept-3b7ba5af6ddf4863b1344fc7b433a729

Open source docs?

When I find stuff missing in the docs and get help in the Slack channel, I wouldn't mind adding an explanation to the documentation. Wouldn't it be helpful to open source the docs so people can submit pull requests?

Add smtp-auth to the Email-docs (`auth`, `username`, `password`)

Update Toggle Field options

See: https://github.com/k-next/plugins/issues/65#issuecomment-409565918

[Docs] Devkit without Public Folder Instructions

as mentioned in Slack.

if anyone were to use the devkit (composer) the configuration would always lead to having a public folder as a requirement. Many hosts do not provide the functionality for having a public folder to protect content so we would have to change some things get rid the public folder and rearrange some folders and files to make it working. But still being able to update our devkit / current nighties and composer.

Index.php and htaccess has to be moved from the public to root folder.
Index.php has to be changed to

<?php
require_once __DIR__ . '/vendor/autoload.php';

$kirby = new Kirby([
    'roots' => [
        'index'    => __DIR__,
        'base'     => $base    = __DIR__,
        'content'  => $base . '/content',
        'site'     => $base . '/site',
        'storage'  => $storage = $base . '/storage',
        'accounts' => $storage . '/accounts',
        'cache'    => $storage . '/cache',
        'sessions' => $storage . '/sessions',
    ]
]);

echo $kirby->render();

since it's kinda searching for a storage folder, as well as setting it's base to one parent directory we need to change it accordingly as above.

We need to move and create inside root

• assets/
• assets/js
• assets/css

as well as

• media
• storage (plus subfolders)

if path's are not set properly inside the index file, the panel e.g. will still prompt to "install" an account, however it won't show any page or information but stay blank.

Recipe: Using Composer for your plugin

https://github.com/k-next/kirby/issues/762

Time field references incorrect parameters for Format and Interval.

Current K3 docs reference incorrect variables for Format and Interval.

  time:
    label: Time (Incorrect)
    type: time
    format: 12
    interval: 30

The correct variables are notation and step.

  time:
    label: Time (Correct)
    type: time
    notation: 12
    step: 30

Urls error

The urls does not work for me:

https://nnnnext.getkirby.com/docs/guide/panel/blueprints/columns
https://nnnnext.getkirby.com/docs/guide/panel/blueprints/sections

But they show up here:

https://nnnnext.getkirby.com/docs/search?q=blueprint+definition

"Kirby 3 field plugins are made of three parts:" should be "section plugins"

A copy/pasting issue:

https://nnnnext.getkirby.com/docs/guide/extending-kirby/plugin-types/sections#kirby-3-field-plugins-are-made-of-three-parts

field user or users

https://nnnnext.getkirby.com/docs/cheatsheet/fields/user

user does not work but users does.

Routes as callbacks

Kirby::plugin('demo/plugin', [
	'routes' => function ($kirby) {
		return [
			[
				'pattern' => '...',
				'action' => function () {

				}
			]
		];
	}
]);

Adapt options for tags field

Update glossary links

Add guide for Uberspace

I know not really a website issue for our own, but I didn't know where to put it for the moment... so until 3.0 has been released:

Would be great to add a PR for Uberspace with a guide how to install Kirby. Like: https://github.com/Uberspace/lab/pull/207/files

typo in plugin section

On https://nnnnext.getkirby.com/docs/guide/extending-kirby/plugin-types/fields in the final .js snippet you use bracket around a javascript object:

panel.plugin('your/plugin', [
  'fields': {
    'hello': {
      props: {
        message: String
      },
      template: '<p>{{ message }}</p>'
    }
  }
]);

should become

panel.plugin('your/plugin', {
  'fields': {
    'hello': {
      props: {
        message: String
      },
      template: '<p>{{ message }}</p>'
    }
  }
});

Plugin Types Routes missing

I'm missing the Plugin Types Routes here:
https://nnnnext.getkirby.com/docs/guide/extending-kirby/plugin-types

To find it I needed to go here:
https://nnnnext.getkirby.com/docs/guide/routing

I expected it more to be in the list of "Plugin Types" than under "Routing" because it has to do with extending the plugin when using Kirby::plugin.

Possible solutions

1. Add it in both places WET.
2. Add it in plugin-types/routes and then link to that page from the more general routing page.

Page models in model folder

Extending blueprints as separate blueprint docs subsection

Check Notion docs for other stuff that hasn't been ported yet

Duplicate definition for "Page"

http://85.90.245.237/docs/glossary

[Plugins] Composer dependency order and DevKit

i am using the DevKit setup via composer and my plugins id look like bnomei/something. but when i create them as composer plugins and publish them on packagist and require them again this will cause an error.

Kirby class not found.

why? because bnomei/something gets loaded before getkirby/cms.
i temporarly fixes this by requiring getkirby/cms in my plugins and ignoring vendor, folder but this way i will not be able to serve clean zips (which can be extracted in site/plugins/ folder ) once betas are over.

my composer knowledge is limited... maybe it can be done. any ideas how to solve this?

Listed and unlisted pages: Sorting options described but not how it's done.

https://nnnnext.getkirby.com/docs/guide/pages/listed-and-unlisted-pages
describes the different sorting options but doesn't show how to realize them (i.e. num: date or num: zero).

How to add new Panel views

Query language in the image option uses `query` instead of `src`

The Querying an image in the image option part shows:

image:
  src: page.images.template("cover").first
  ratio: 1/1
  cover: true

I can't get src to work in any way but using query instead works perfectly.

Glossary term missing in the docs

At this page https://nnnnext.getkirby.com/docs/guide/blueprints/query-language

Comma missing in composer.json instructions

https://nnnnext.getkirby.com/docs/guide/extending-kirby/plugin-basics

See at the end of description.

{
  "name": "superwoman/superplugin",
  "description": "This plugin gives superpowers to your website"
  "version": "1.0.0",
  "autoload": {
        "files": ["config.php"],
  }
}

While at it, the comma efter files should not be there.

Link with wrong url

At the very end of this page : https://nnnnext.getkirby.com/docs/guide/extending-kirby/plugin-types/routes

The link on the phrase...

For more information on routing see the routing docs

...is pointing to an url that has an extra : at the end and this results in an error.

Current link is this https://nnnnext.getkirby.com/docs/guide/routing:
Should be this https://nnnnext.getkirby.com/docs/guide/routing

search

Will you incorporate some way to search the docs?

$site->user() should be $kirby->user()

Missing indentation in columns example

The part from type: fields and the following lines in that section need to be indented.
Docs page: https://nnnnext.getkirby.com/docs/guide/blueprints/columns

[Docs] Panel UI palette

All the colors used in the panel. Someone, maybe Fabian had a great list of colors a long time ago.

If there are css variables that we can use, it may be helpful as well.

Update composer.json

See demo plugin.

Add missing plugin types

• collections
• validators
• options
• site methods

Some "Quickstart" links are broken

In the section Where to go from here the links linking to "What's new in Kirby 3" and "Upgrade Guide" are linking to non-existing pages. I think they are just located elsewhere.

Missing: How to add custom panel page

Layout list option for tags

Time field references incorrect parameters for Format and Interval.

Current K3 docs reference incorrect variables for Format and Interval.

  time:
    label: Time (Incorrect)
    type: time
    format: 12
    interval: 30

The correct variables are notation and step.

  time:
    label: Time (Correct)
    type: time
    notation: 12
    step: 30

Include sessions docs from Notion concepts

https://www.notion.so/getkirby/Sessions-Concept-7d678d4d00c846ed81b3f98b71c6bc9b

More info about response types

https://nnnnext.getkirby.com/docs/guide/routing#response-types

Many of the response types are self explained, but some are not really. For example this one:

return false;

I was hoping it would return the error page along with the header 404 and it seems like it does that.

But it could return false on the screen, it does not say.

To have just a line what the output will be and what header is sent would be helpful.

How to access structure fields etc. in query language

A note about using frontend features like page models and custom methods in the Panel

Add more helpers to the cheatsheet

Some helpers from kirby/config/helpers.php are missing from the cheat-sheet or from the docs at all. (e.g. invalid()).

Update/activate multilang docs

Plugin translations

New in beta 4

Kirby::plugin('demo/plugin', [
	'translations' => [
		'en' => [
			'export' => 'Export', 
		],
		'de' => [
			'export' => 'Exportieren', 
		]	
	]
]);

panel.plugin('demo/plugin', {
	fields: {
		export: {
			template: "<k-button>{{ $t('export') }}</k-button>"
		}
	}
});

Sourcecode links don't work with traits

At least I think this is the problem.

Example:
http://[ccccensored]/docs/framework/cms/app/user

links to https://github.com/k-next/kirby/blob/develop/src/Cms/App.php#L109

I guess this is because the function lives in a trait.
The line number is right, the filename is wrong:
https://github.com/k-next/kirby/blob/develop/src/Cms/AppUsers.php#L109

Widgets from K2 still in the Glossary