Download the PHP package olssonm/ampersand without Composer
On this page you can find all versions of the php package olssonm/ampersand. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download olssonm/ampersand
More information about olssonm/ampersand
Files in olssonm/ampersand
Package ampersand
Short Description Plug and play flat file markdown blog for your Laravel-projects
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ampersand
Ampersand
Plug-and-play flat file markdown blog tool for your Laravel-project. Create an article or blog-section on your site without the hassle of setting up tables, models or your own flat file-system.
Built upon spatie/sheets to handle the markdown-files and YAML-front matter parsing.
Note: This package is built for quick and easy setup and use – don't expect a fully featured CMS.
🛠 Install and configure
Require package:
Publish config-files and views:
In config/ampersand.php you can now customize the settings to your liking. Views are available at resources/views/vendor/ampersand
✏️ Writing posts
Filename format
All posts should be stores in your posts_path-directory with the filename format of 2021-03-30.my-post.md, i.e. {date:Y-m-d}.{slug}.md.
The slug is what determins at what URL your post will be available at.
Artisan command
You can quickly create a new post via the artisan command:
YAML front matter
Posts can contain any number of attributes via YAML-front matter:
🖥 Displaying posts
Two views are shipped with this package; an index-view and a show-view (used for single posts). They are located in /resources/vendor/views/ampersand after installation and are fully customizable.
In index.blade.php a collection of post-objects is available via the $posts-variable. It behaves much as a standard Eloquent-collection.
Pagination-links are also available:
The Post-object contains all your front matter attributes as well as slug, date and contents.
Retrieve posts in your application
You can retrieve posts and filter them as a collection anywhere in your application using the Post-model:
The posts are sorted by descending date per default, so to get the latest post:
🚦 Routes
The package routes are ampersand.index and ampersand.show:
Defining your own routes
The default routes are registered with the ampersand-name and the default web-middleware group.
If you by any reason want to override this (for example if you want to have your articles behind a login or maybe you don't use the standard web-middleware group), you may set register_routes to false in ampersand.php, and then register them yourself:
See it in action
Sites in the wild that uses Ampersand
Do you use Ampersand and want your site featured here? Submit a PR!
License
The MIT License (MIT). Please see the LICENSE.md for more information.
© 2021 Marcus Olsson.
