Commit graph

296 commits

Author SHA1 Message Date
Daniel Rudolf 7f4ad75245 Refactor phpDoc auto-deployment 2015-11-23 21:46:36 +01:00
theshka e79388118c Merge branch 'feature/auto-docs' into enhancement/build-release 2015-11-23 13:35:23 -06:00
theshka c3b908939f update deploy-phpdoc.sh for auto docs 2015-11-23 13:26:31 -06:00
theshka 04f7140347 update .travis.yml for auto-docs 2015-11-23 13:19:47 -06:00
theshka edbf9f1747 Implement @PhrozenByte 's suggestions.
* [Changed] require phpDocumentor version ^2.8 constraint
2015-11-23 12:27:15 -06:00
theshka bf2a9622db Update deploy script
* [Changed] move everything inside /build/ directory
* [Changed] use absolute file paths in script
* [Changed] copy docs to both the release number and master dirs
Implement @PhrozenByte 's suggestions.
* [Changed] use `$GITHUB_OAUTH_TOKEN` instead of `$GITHUB_TOKEN`
2015-11-23 12:27:15 -06:00
theshka e0c6383406 rename script 2015-11-23 12:27:15 -06:00
theshka 7f910e913f update auto-docs files
* [Changed] move everything inside /build/ directory
Implement @PhrozenByte 's suggestions.
* [Changed] don't change directories, pass the paths
* [Removed] unnecessary `composer install`, travis-ci runs this already
* [Removed] unnecessary `composer self-update` command
* [Removed] unnecessary php version check on script
2015-11-23 12:26:25 -06:00
theshka f062640bb1 test auto docs 2015-11-20 23:28:09 -06:00
theshka f6d5e8c7f4 can phpDoc be automatic? 2015-11-20 20:30:56 -06:00
theshka 31d611a507 add template for new issues 2015-11-18 18:55:26 -06:00
theshka 8093758b3e Improve headings and formatting 2015-11-18 15:26:39 -06:00
theshka ba766ea65c Update Build & Release section 2015-11-18 13:39:48 -06:00
Daniel Rudolf 3e4bcd4289 Update CONTRIBUTING.md: Fix typo 2015-11-18 00:41:38 +01:00
Daniel Rudolf 3b737aac1a Update README.md: Update "edit inline docs" link 2015-11-18 00:34:59 +01:00
Daniel Rudolf c0d30d20f8 Follow-up to c72ea0e
Don't use Pico::getAbsolutePath() for $config['content_dir'], just make sure the trailing slash exists. The config.php in Picos root dir should be interpreted exactly like in Pico 0.9 (the option didn't exist in Pico 0.8), thus the path isn't necessarily relative to Picos root dir
2015-11-14 16:50:32 +01:00
Daniel Rudolf 71076e8eba Update CHANGELOG.md 2015-11-14 00:27:49 +01:00
Daniel Rudolf e0c1e068fb Default theme: Improve table styling 2015-11-14 00:26:45 +01:00
Daniel Rudolf 636f27ae2f Add asset handling recommendations to inline user docs
Thanks @smcdougall for giving the hint about this
2015-11-14 00:26:26 +01:00
Daniel Rudolf aa68cfaa45 Update CHANGELOG.md 2015-11-13 22:34:47 +01:00
Daniel Rudolf f5006c036a Prevent double slashes in base_url when installed to document root
Fixes #274
2015-11-13 22:29:58 +01:00
Daniel Rudolf c72ea0ecec PicoDeprecated: Sanitize content_dir and base_url options when reading config.php in Picos root dir 2015-11-13 19:10:30 +01:00
Daniel Rudolf 282b7ce16c Update CHANGELOG.md 2015-11-12 20:36:05 +01:00
Daniel Rudolf 78ceabe878 Various improvements
- Reuse ParsedownExtra object
- Add new markdown Twig filter
- Improve class docs in general
- Document plugin number prefix usage
2015-11-12 15:34:56 +01:00
Daniel Rudolf 8ff18c9366 Update CHANGELOG.md 2015-11-08 14:35:28 +01:00
Daniel Rudolf f9e9642c22 Fix Pico::getPageUrl()
With enabled URL rewriting we must call rawurlencode() on the file path parts rather the whole path
2015-11-08 14:01:35 +01:00
Daniel Rudolf 6638c2b0ee CONTRIBUTING.md: Clarify the suggested branching concept 2015-11-08 03:54:58 +01:00
Daniel Rudolf 2ca711ad59 Add missing rawurlencode() to Pico::getPageUrl()
Replace urldecode() in Pico::evaluateRequestUrl() with rawurldecode()
See #272 for details, thanks @smcdougall for spotting!
2015-11-08 03:12:18 +01:00
Daniel Rudolf e144cce6b1 Update .gitignore 2015-11-06 21:19:17 +01:00
Daniel Rudolf 7b4ad7f234 Version 1.0.0-beta.1
**Note:** This changelog only provides basic information about the enormous
          changes introduced with Pico 1.0.0-beta.1. Please refer to the
          UGPRADE section of the docs for details.

```
* [Security] (9e2604a) Prevent content_dir breakouts using malicious URLs
* [New] Pico is on its way to its first stable release!
* [New] Provide pre-bundled releases
* [New] Heavily expanded documentation (inline code docs, user docs, dev docs)
* [New] New routing system using the QUERY_STRING method; Pico now works
        out-of-the-box with any webserver and without URL rewriting; use
        `%base_url%?sub/page` in markdown files and `{{ "sub/page"|link }}`
        in Twig templates to declare internal links
* [New] Brand new plugin system with dependencies (see `PicoPluginInterface`
        and `AbstractPicoPlugin`); if you're plugin dev, you really should
        take a look at the UPGRADE section of the docs!
* [New] Introducing the `PicoDeprecated` plugin to maintain full backward
        compatibility with Pico 0.9 and Pico 0.8
* [New] Support YAML-style meta header comments (`---`)
* [New] Various new placeholders to use in content files (e.g. `%site_title%`)
* [New] Provide access to all meta headers in content files (`%meta.*%`)
* [New] Provide access to meta headers in `$page` arrays (`$page['meta']`)
* [New] The file extension of content files is now configurable
* [New] Add `Pico::setConfig()` method to predefine config variables
* [New] Supporting per-directory `404.md` files
* [New] #103: Providing access to `sub.md` even when the `sub` directory
        exists, provided that there is no `sub/index.md`
* [New] #249: Support the `.twig` file extension for templates
* [New] #268, 269: Now using Travis CI; performing basic code tests and
        implementing an automatic release process
* [Changed] Complete code refactoring
* [Changed] Source code now follows PSR code styling
* [Changed] Replacing constants (e.g. `ROOT_DIR`) with constructor parameters
* [Changed] Paths (e.g. `content_dir`) are now relative to Pico's root dir
* [Changed] Adding `Pico::run()` method that performs Pico's processing and
            returns the rendered contents
* [Changed] Renaming all plugin events; adding some new events
* [Changed] `Pico_Plugin` is now the fully documented `DummyPlugin`
* [Changed] Meta data must start on the first line of the file now
* [Changed] Dropping the need to register meta headers for the convenience of
            users and pure (!) theme devs; plugin devs are still REQUIRED to
            register their meta headers during `onMetaHeaders`
* [Changed] Exclude inaccessible files from pages list
* [Changed] With alphabetical order, index files (e.g. `sub/index.md`) are
            now always placed before their sub pages (e.g. `sub/foo.md`)
* [Changed] Pico requires PHP >= 5.3.6 (due to `erusev/parsedown-extra`)
* [Changed] Pico now implicitly uses a existing `content` directory without
            the need to configure this in the `config/config.php` explicitly
* [Changed] Composer: Require a v0.7 release of `erusev/parsedown-extra`
* [Changed] #93, #158: Pico doesn't parse all content files anymore; moved to
            `PicoParsePagesContent` plugin, but still impacts performance;
            Note: This means `$page['content']` isn't available anymore, but
            usually the new `$page['raw_content']` is suitable as replacement.
* [Changed] #116: Parse meta headers using the Symfony YAML component
* [Changed] #244: Replace opendir() with scandir()
* [Changed] #246: Move `config.php` to `config/` directory
* [Changed] #253: Assume HTTPS if page is requested through port 443
* [Changed] A vast number of small improvements and changes...
* [Fixed] Sorting by date now uses timestamps and works as expected
* [Fixed] Fixing `$currentPage`, `$nextPage` and `$previousPage`
* [Fixed] #99: Support content filenames with spaces
* [Fixed] #140, #241: Use file paths as page identifiers rather than titles
* [Fixed] #248: Always set a timezone; adding `$config['timezone']` option
* [Fixed] A vast number of small bugs...
* [Removed] Removing the default Twig cache dir
* [Removed] Removing various empty `index.html` files
* [Removed] Moving Pico's excerpt feature to `PicoExcerpt` plugin
```
2015-11-06 19:13:17 +01:00
Daniel Rudolf 2d6859af60 Update .travis.yml 2015-11-06 19:13:01 +01:00
Daniel Rudolf e5b0ec6d7b Merge pull request #252 from PhrozenByte/pico1.0
Pico 1.0
2015-11-06 19:06:39 +01:00
Daniel Rudolf cd1dc07d81 Sync docs 2015-11-06 17:50:22 +01:00
theshka 82cbe37009 fix typos 2015-11-06 10:15:28 -06:00
Daniel Rudolf e3e0300025 Fix typo 2015-11-06 02:02:04 +01:00
Daniel Rudolf cd7cd374bb Add content filter to get the parsed contents of a page (lazy loading) 2015-11-06 01:08:31 +01:00
Daniel Rudolf b5d54d05c4 Update .travis.yml: Name release archives "pico-release-$TRAVIS_TAG.tar.gz"
Should make it easier for a ordinary user to distinct source code and release 😃
2015-11-05 21:58:45 +01:00
Daniel Rudolf 19f708e572 Sync documentation 2015-11-04 22:44:19 +01:00
Daniel Rudolf af8de56512 Fix typos 2015-11-04 19:50:44 +01:00
Daniel Rudolf 2a43b21bae Enable PicoDeprecated if no plugins are loaded 2015-11-04 19:44:20 +01:00
Daniel Rudolf ccac8dd4d3 Force trailing slash of $config['base_url'] and force existance of $config['timezone'] 2015-11-04 19:43:54 +01:00
Daniel Rudolf e3a6116c79 Sync documentation 2015-11-04 19:43:06 +01:00
Daniel Rudolf 90128f4946 Fix possible foreach on null errors 2015-11-03 23:49:34 +01:00
Daniel Rudolf 82e0ca5216 Small changes
- Use Travis build status
- Update version number in config template
2015-11-03 17:35:33 +01:00
Daniel Rudolf 8164038ff7 Use Markdown for CHANGELOG.md 2015-11-03 17:34:41 +01:00
Daniel Rudolf 48264fce3d Move license.txt and changelog.txt 2015-11-03 17:32:58 +01:00
Daniel Rudolf 365333c62e Update content-sample/index.md 2015-11-03 16:35:27 +01:00
Daniel Rudolf ffc59362be README.md: Add Getting Help section 2015-11-03 15:50:39 +01:00
Daniel Rudolf 2ab361106c Update content-sample/index.md 2015-11-03 00:41:10 +01:00
Daniel Rudolf d65eb553ad Update README.md 2015-11-03 00:09:31 +01:00