Giter VIP home page Giter VIP logo

mdkb's Introduction

PHP Markdown Knowledge Base

Inspired by Raneto

This works pretty similarly to Raneto except it doesn't (currently) have an admin area. All files need to be manually added to the content folder.

Installation

Download the repo then install with composer

Creating Categories

  • Add folders to the content folder (this can be changed in the src/config.php) file.
  • You can sort categories by something other than name if you include a file named "sort" in the category folder
  • You can use a different name compared to what the folder is named by creating a file named "actual_name" in the category folder

Creating Pages

  • Add markdown (.md) files to the category folder.
  • In the markdown files you can set the title and sort order by including it in the top of the file.
  • Example:
Title: This is a title
Sort: 1
---
This is the page content

Routes

Routes are determined by the category/page name combo. For example if you have a folder named "category-1" and inside that folder is a file named "page-one.md", the route to the knowledge base page would be http://yoursite.com/category-1/page-one

mdkb's People

Contributors

leorojas22 avatar

Watchers

James Cloos avatar  avatar

Forkers

erichuang2015

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.