forked from picocms/picocms.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b56e15f
commit 48ae8bf
Showing
15 changed files
with
1,865 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| {% if include.mode == "buttons" %} | ||
| <div class="btn-group aligncenter"> | ||
| {% assign buttons = include.buttons|split: ", " %} | ||
| {% for button in buttons %}<button class="btn" id="{{ button }}-btn">{{ button }}</button>{% endfor %} | ||
| </div> | ||
| {% endif %} | ||
|
|
||
| {% if include.mode == "start" %} | ||
| <div class="btn-group-content" id="{{ include.id }}-section" markdown="1"> | ||
| {% endif %} | ||
|
|
||
| {% if include.mode == "end" %} | ||
| </div> | ||
| {% endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,93 @@ | ||
| --- | ||
| layout: docs | ||
| nav: 3 | ||
| title: Docs | ||
| headline: Pico Documentation | ||
| headline: Table of Contents | ||
| description: | | ||
| Pico is a flat file CMS, this means there is no administration backend or database to deal with.<br /> | ||
| You simply create .md files in the "content" folder and that becomes a page. | ||
| collection: docs | ||
| nav: 3 | ||
| redirect_from: /docs.html | ||
| Pico is stupidly simple, but incredibly powerful.<br> | ||
| But with great power comes a little bit of a reading responsibility. | ||
| # That power comes with a little bit of reading though. | ||
| toc: | ||
| installing-and-configuring-pico: Installing and Configuring Pico | ||
| creating-content: Creating Content | ||
| theming-with-twig: Theming with Twig | ||
| deconstructing-the-defaults: Deconstructing the Defaults | ||
| twig-tips-and-tricks: Twig Tips and Tricks | ||
| the-power-of-plugins: The Power of Plugins | ||
| --- | ||
|
|
||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| <!-- Shouldn't these be auto-generated from descriptions or something? | ||
| Mabye, but descriptions are too short. | ||
| --> | ||
|
|
||
| <!-- Quick synopsis of what the article covers (a wide variety of web servers: balh blah) | ||
| Actual docs won't be searchable anymore, so these descriptions should be well done and cover everything. | ||
| --> | ||
|
|
||
| ## [Installing and Configuring Pico][Installing] | ||
| <!-- These should probably light up when hovered, and the background should be clickable, but that's all extra JS --> | ||
|
|
||
| There are many options for downloading and installing Pico. From automated choices like Composer and Git to just downloading an old-fashioned zip file. There's even a version of Pico available on the Nextcloud App Store. | ||
|
|
||
| This guide will cover all the basics of getting Pico installed, configuring your webserver (whether you use Apache, Nginx, Lighttpd, or Caddy), to configuring Pico itself. | ||
|
|
||
| If you're new to Pico altogether, you'll probably want to start here, and make your way through each section as you go. | ||
|
|
||
| </div> | ||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| ## [Creating Content][CreatingContent] | ||
|
|
||
| Pico's flat file approach makes creating content a breeze. This guide discusses the basics of using Pico. We'll go over the URL structure of Pico's content folder, the YAML/Markdown format of your content files, and where you should put your assets. | ||
|
|
||
| <!-- Should folder structure be an actual page or section? --> | ||
|
|
||
| </div> | ||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| ## [Theming with Twig][Theming] | ||
|
|
||
| Twig is an incredibly powerful templating language. In this guide, we'll go over how Pico Themes work, how to access the extra Twig variables and filters Pico provides, and point you to some Twig related learning resources. | ||
|
|
||
| <!-- One reoccurring link to Twig's docs counts, right? --> | ||
|
|
||
| </div> | ||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| ## [Deconstructing the Defaults][DeconstructingDefaults] | ||
|
|
||
| The best way to learn is through example, right? Here we break the Default Theme down into bite sized code snippets and explain what the Twig code is doing in them. A lot of the code you'll see will be similer, if not identical, to what you'll need for your own projects. You can even copy them if you'd like. | ||
|
|
||
| </div> | ||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| ## [Twig Tips and Tricks][TwigTips] | ||
|
|
||
| Moving on from the Default Theme, here we'll look at some more advanced examples of tricks you can pull off with Pico and Twig. We'll take a look at how to implement some blogging features as well, like pagination, tagging, and search. | ||
|
|
||
| <!-- Oof, that's a big ask. Better rewrite NotePaper while you're at it. --> | ||
| <!-- Actually, that might be better as a THIRD examples page. Make Tips and Tricks simpler non-Default options. --> | ||
|
|
||
| </div> | ||
| <div markdown="1" class="toc-section"> | ||
|
|
||
| ## [The Power of Plugins][Plugins] | ||
|
|
||
| So you've mastered the power offered by Twig and you're still wanting more? | ||
|
|
||
| Welcome to the world of Plugins. Pico is incredibly extendable via its Plugin system. Utilizing PHP, you can easily hook into Pico to create your own custom functionality. | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| [Installing]: {{ site.github.url }}/guide/installing | ||
| [CreatingContent]: {{ site.github.url }}/guide/creating-content | ||
| [Theming]: {{ site.github.url }}/guide/theming-with-twig | ||
| [DeconstructingDefaults]: {{ site.github.url }}/guide/deconstructing-the-defaults | ||
| [TwigTips]: {{ site.github.url }}/guide/twig-tips-and-tricks | ||
| [Plugins]: {{ site.github.url }}/guide/plugins |
Oops, something went wrong.