diff --git a/_docs/customization.md b/_docs/customization.md index e6523be..95bc526 100644 --- a/_docs/customization.md +++ b/_docs/customization.md @@ -91,10 +91,6 @@ designers created in the past. As with plugins, you can find themes in #### Plugins for users -Officially tested plugins can be found at http://pico.dev7studios.com/plugins, -but there are many awesome third-party plugins out there! A good start point -for discovery is [our Wiki](https://github.com/picocms/Pico/wiki/Pico-Plugins). - Pico makes it very easy for you to add new features to your website. Simply upload the files of the plugin to the `plugins/` directory and you're done. Depending on the plugin you've installed, you may have to go through some more diff --git a/_plugin-dev/basics.md b/_plugin-dev/basics.md index 02b41a8..cf03e90 100644 --- a/_plugin-dev/basics.md +++ b/_plugin-dev/basics.md @@ -5,5 +5,8 @@ nav: 1 --- # Basics +Creating your own content for Pico is *easy*. -Coming soon! +Inside the root Pico folder, all *themes* reside in the `themes` directory, +and all *plugins* in the `plugins` directory. (As a developer, you may have +changed these paths and/or directory names when you initialized Pico.) diff --git a/_plugin-dev/core.md b/_plugin-dev/core.md new file mode 100644 index 0000000..962977c --- /dev/null +++ b/_plugin-dev/core.md @@ -0,0 +1,13 @@ +--- +toc: + core: + _title: Core + +nav: 2 +--- + +#Pico Core + +It's generally not a good idea to make modifications to the core of Pico. If you +are looking to add or change functionality, can it be accomplished with a plugin? +If not, and you are interested in helping to develop the Pico core, [fork us on GitHub](https://github.com/picocms/Pico)! diff --git a/_plugin-dev/plugins.md b/_plugin-dev/plugins.md new file mode 100644 index 0000000..8e70dde --- /dev/null +++ b/_plugin-dev/plugins.md @@ -0,0 +1,84 @@ +--- +toc: + plugins: + _title: Plugins + migrating: Migrating 0.X -> 1.0 + your_first: Your First Plugin +nav: 3 +--- + +#Plugins +At the heart of customizing Pico is a plugin. You can 'hook-in' to the Pico +engine at many different times during the rendering of your site and its content. +You will find a full example template in `plugins/DummyPlugin.php` to get you +started on building some great stuff. Otherwise, keep reading to learn how to +create your first plugin! + +Officially tested plugins can be found at http://pico.dev7studios.com/plugins, +but there are many awesome third-party plugins out there! A good start point +for discovery is our [Wiki](#plugin-wiki). + +#Migrating from 0.X -> 1.0 +The new event system supports plugin dependencies as well as some new events. +You will be able to set an enabled/disabled state by default as well. If you +have previously cerated a plugin for Pico, it is *HIGHLY* recommended that you +update your class to extend from `AbstractPicoPlugin` and use the new events +to avoid activating the `PicoDeprecated` plugin. + + |---------------------|-----------------------------------------------------------| + | Event | ... triggers the deprecated event | + |---------------------|-----------------------------------------------------------| + | onPluginsLoaded | plugins_loaded() | + | onConfigLoaded | config_loaded($config) | + | onRequestUrl | request_url($url) | + | onContentLoading | before_load_content($file) | + | onContentLoaded | after_load_content($file, $rawContent) | + | on404ContentLoading | before_404_load_content($file) | + | on404ContentLoaded | after_404_load_content($file, $rawContent) | + | onMetaHeaders | before_read_file_meta($headers) | + | onMetaParsed | file_meta($meta) | + | onContentParsing | before_parse_content($rawContent) | + | onContentParsed | after_parse_content($content) | + | onContentParsed | content_parsed($content) | + | onSinglePageLoaded | get_page_data($pages, $meta) | + | onPagesLoaded | get_pages($pages, $currentPage, $previousPage, $nextPage) | + | onTwigRegistration | before_twig_register() | + | onPageRendering | before_render($twigVariables, $twig, $templateName) | + | onPageRendered | after_render($output) | + |---------------------|-----------------------------------------------------------| + +#Your First Plugin + +## 1. To get started, navigate to your `plugins` directory +![Step1](style/images/docs/pico_plugins.jpg) + +--- + +## 2. Create a new folder and name it your desired name using CammelCase +![Step2](style/images/docs/pico_plugins_myplugin.jpg) + +> *Note:* It's not necessary to create the folder, if you do not have assets to +> include, you can simply skip this step and continue to Step 3 + +--- + +## 3. Next, you should copy `DummyPlugin.php` inside your newly created folder and give it the same name as you did the folder +![Step3](style/images/docs/pico_plugins_myplugin_php.jpg) + +--- + +## 4. You will need to name the `class` the same as the `folder` and the `.php` file +![Step4](style/images/docs/pico_plugins_myplugin_php_class.jpg) + +--- + +## 5. From here, you will be able to hook-in to Pico's processing +Choose an event that makes sense for your situation. Do you need to load configuration values? +`onConfigLoaded`. You need to modify the content of the page before it is +rendered by markdown? `onPageRendering`. Etc... Plugin developers shouldn't +manipulate data in "wrong" events, this could lead to unexpected behavior. + +> *Note:* Don't forget to set your plugins enabled/disabled state, either by default or +> through your sites `config/config.php` file. + +--- diff --git a/_plugin-dev/wiki.md b/_plugin-dev/wiki.md new file mode 100644 index 0000000..2a5b4ac --- /dev/null +++ b/_plugin-dev/wiki.md @@ -0,0 +1,10 @@ +--- +toc: + wiki: Wiki +nav: 3 +--- + +#Plugin Wiki +Whether you have an awesome new plugin you've created and you're dying to share, +or if you're a new plugin developer and you're looking for some inspiration-- +our [Pico Plugin Wiki](https://github.com/picocms/Pico/wiki/Pico-Plugins) is here to help! diff --git a/plugin-dev.html b/plugin-dev.html index cb4cd0a..127f65d 100644 --- a/plugin-dev.html +++ b/plugin-dev.html @@ -9,9 +9,7 @@ nav: 3

Create your own plugins & themes

- Pico is highly customizable in two different ways:
- On the one hand you can change Picos apperance by using themes,
- on the other hand you can add new functionality by using plugins. + Pico is highly customizable -- the possibilites are endless when you're in control.


diff --git a/plugins.html b/plugins.html index 393e574..42bff6c 100644 --- a/plugins.html +++ b/plugins.html @@ -12,26 +12,32 @@ nav: 4 Want to make a plugin? See the docs.


+

Pico 1.0

-

RSS Feed

-

Provides an RSS Feed for Pico. It will only include content with a "Date" field.

-

Download

+

Tags

+

Provides tags functionality for Pico.

+

Download

-
-

Draftin

-

- This is a Pico plugin that integrates Draft into Pico. - You can see a tutorial on how to use it on Codeforest. -

-

Download

+
+

Editor

+

Markdown editor and file manager for Pico.

+

Download

-

Editor

-

Provides an online Markdown editor and file manager for Pico.

-

Download

+

Pico GAnalytics

+

Gooogle Analytics for Pico with basic options.

+

Download


+
+

Pico GitHub Activity

+

Your GitHub public activity feed.

+

Download

+
+

+ +

Pico 0.X

Pagination

Provides basic pagination for Pico.

@@ -77,9 +83,19 @@ nav: 4

Download

-

Tags

-

Provides tags functionality for Pico.

-

Download

+

RSS Feed

+

Provides an RSS Feed for Pico.

+

Download

+
+

+ +
+

Draftin

+

+ This is a Pico plugin that integrates Draft into Pico. + You can see a tutorial on how to use it on Codeforest. +

+

Download


diff --git a/style/images/docs/pico_plugins.jpg b/style/images/docs/pico_plugins.jpg new file mode 100644 index 0000000..a63f99b Binary files /dev/null and b/style/images/docs/pico_plugins.jpg differ diff --git a/style/images/docs/pico_plugins_myplugin.jpg b/style/images/docs/pico_plugins_myplugin.jpg new file mode 100644 index 0000000..a03966b Binary files /dev/null and b/style/images/docs/pico_plugins_myplugin.jpg differ diff --git a/style/images/docs/pico_plugins_myplugin_php.jpg b/style/images/docs/pico_plugins_myplugin_php.jpg new file mode 100644 index 0000000..eb050f2 Binary files /dev/null and b/style/images/docs/pico_plugins_myplugin_php.jpg differ diff --git a/style/images/docs/pico_plugins_myplugin_php_class.jpg b/style/images/docs/pico_plugins_myplugin_php_class.jpg new file mode 100644 index 0000000..f5d703e Binary files /dev/null and b/style/images/docs/pico_plugins_myplugin_php_class.jpg differ