Download the PHP package nyoncode/laravel-knowledge-base without Composer

On this page you can find all versions of the php package nyoncode/laravel-knowledge-base. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of nyoncode/laravel-knowledge-base

Informations about the package laravel-knowledge-base

Laravel Knowledge Base

A knowledge base you can put in front of customers, your team, or both — in one installation. Diátaxis-shaped articles, search-first navigation, revisions, reader feedback and a freshness clock. Ships Livewire 3/4 components and Blade views you can publish and restyle.

That is the whole install. The base mounts itself at /napoveda.

What it is opinionated about

Three decisions are baked in, because a knowledge base that gets them wrong fails quietly rather than loudly.

Search first, tree second. Readers arrive with a sentence, not a place in a hierarchy. The landing page is one autofocused field; the category grid is what catches the people whose sentence failed. <livewire:kb.search /> puts the same search behind ⌘K on every page of your app.

Status and visibility are two questions. Status is our readiness (draft → in review → published). Visibility is whose eyes (internal / public). A finished internal runbook is published and internal. One combined "publish" button is how private notes reach the open web, so there isn't one.

A page nobody has confirmed is suspect. Every article carries a review clock. Past its date it says so to the reader, in a banner, and appears in the maintainer's queue. A knowledge base does not break — it rots, and this is the only thing that surfaces it.

The four kinds

Articles declare what they are for (Diátaxis), which drives the badge, the reading order inside a category, and the one-line promise under the title:

Kind For a reader who…
Tutorial is learning, and needs a guaranteed-working first run
How-to already has a goal and needs the steps
Reference knows what they want and needs the exact value
Background wants to understand why it works this way

Choose your editor

Markdown, TipTap or blocks — per installation, and the format is stored per article, so switching the default later leaves everything written before it rendering exactly as it did.

Markdown is the default deliberately: no JavaScript, clean diffs between revisions, and it outlives the next editor fashion. Pick another when the people writing will not write markdown — a real reason, and the only good one.

TipTap ships as a shell, not a bundle. Bundling an editor would push a second copy of ProseMirror into apps that already have one, so the host builds it, exposes window.kbEditor(el, { content, onChange }) and flips editors.tiptap.bundled to true. Until then the driver is not offered at all — an editor that renders an inert box is worse than one that is absent.

You do not have to write that adapter. The package ships it as source in resources/js/kb-editor.js — every extension the editor's toolbar promises, already wired to the contract. Point your bundler at it and install the TipTap packages it imports; they stay your dependencies, at your version, which is the whole point of not shipping a bundle.

Your own is one class:

Make it yours

Everything replaceable is a contract with a shipped default:

Contract Default Replace it when…
KnowledgeAudience gate ability, else any signed-in user "internal" means customers, tenants, one admin…
ArticleSearch portable SQL, weighted by column you outgrow a few thousand articles → Scout
ContentRenderer CommonMark / rich text / blocks you want a syntax highlighter, or a fourth format
EditorDriver markdown / TipTap / blocks you have your own writing surface

Read KnowledgeAudience before you ship. The default is right for a single-team back office and wrong for a customer portal, and the failure mode is a leak. Two methods, both needed: canSeeInternal() styles the UI, scopeVisible() is what actually keeps rows out of the answer — hiding a link is not the same as not returning the row.

Components

Component What it is
<livewire:kb.home /> search + category map
<livewire:kb.search /> ⌘K palette, drop it in your layout
<livewire:kb.category :category="$c" /> one collection, grouped by kind
<livewire:kb.article :article="$slug" /> the page, with contents and feedback
<livewire:kb.admin.articles /> maintenance queue
<livewire:kb.admin.editor :article="$a" /> write

Registered under kb.*; register your own class under the same name last and yours wins.

Views

php artisan vendor:publish --tag=knowledge-base-views

Tailwind utility classes, no build step, dark mode throughout. The prose block is marked .kb-prose so you can scope typography without fighting the rest.

Testing

License

MIT.

All versions of laravel-knowledge-base with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
illuminate/contracts Version ^12.0|^13.0
illuminate/database Version ^12.0|^13.0
illuminate/support Version ^12.0|^13.0
league/commonmark Version ^2.4
nyoncode/laravel-package-toolkit Version ^2.0
symfony/html-sanitizer Version ^7.0|^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nyoncode/laravel-knowledge-base contains the following files

Loading the files please wait ...