Download the PHP package immrdimm/docketwiki without Composer
On this page you can find all versions of the php package immrdimm/docketwiki. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 docketwiki
DocketWiki
See demo here DocketWiki
- About
- How To
- Getting Started
- Requirements
- Install
- Files, Directories and Structure of DocketWiki
- Configuration
- Config structure
- Main settings
- Sidebar navigation settings
- Subtitle item
- Menu item
- Elements
- Headings
- Texts and other
- Paragraphs
- Blockquote
- Code block
- Links
- Footnotes
- Lists
- Unordered list
- Ordered list
- Nested list
- Tables
- Images
- Alerts
- Accordeon
- Icons
About
DocketWiki is simple and static documentation for your project or knowledge base
DocketWiki based on MD-files without Database
You do not need powerfull server, database and difficult settings to start
Download archive, upload and unzip on your server. That's all
Based on ParseDown and ParseDown Extra by Emanuil Rusev
Full support of HTML tags and markdown
How To
Getting Started
Before you start, check requirements page
Requirements
The DocketWiki has a few system requirements.
You should ensure that your web server has the following minimum PHP version and extensions:
- PHP >= 7.0
- Fileinfo PHP Extension
- JSON PHP Extension
- No database needed!
Install
Unpack .zip-file into your webserver folder.
That's all!
Files, Directories and Structure of DocketWiki
- assets folder contains custom styles, scripts, images and other resources for project
- css folder contains styles
- js folder contains custom java-script files
- favicon folder contains favicons
- icons folder contains icons for menu
- documents folder contains all your MD-files
- errors folder contains templates for error-pages
- classes folder contains project classes
- libs folder contains additional third-party libs
- layouts folder contains templates for view
- sidebar folder contains sidebar views
- template folder contains main views
- index.php entry point of all project
- .htaccess rules and conditions for webserver
- config.json configuration file
- config_example.json additional example of configuration file
Configuration
All settings of your DocketWiki placed on config.json at root-folder
You can use config.json of this demo or rename config_example.json and place your changes.
Config structure
Config contain:
- Main Wiki settings
- Sidebar navigation settings
Main settings
First block of settings contain next code:
where is:
- version of your Wiki
- wiki_name name of your Wiki
- wiki_root_url place '/' if it is root folder, or '/folder_name/' if it is a subfolder of existing website
- start_page place started url of your Wiki
Sidebar navigation settings
Sidebar navigation settings contain an array with all menu-items like this:
where is:
- sidebar - root node for sidebar settings. required.
- menu - root node for menu settings. required.
- menu sub-nodes can be tow types: simple menu-item with icon, text and bubble or subtitle-text
Subtitle item
Subtitle item - simple text without links, icons etc.
- type - type of item. required.
- name - text of item. required.
Menu item
Menu item - link to page of DocketWiki
- type - type of item. required.
- icon - icon of item. you can choose icon on Icons page of this DocketWiki
- name - text of item. required.
- url - url-link of item. required.
- bubble - bubble-type of item. can be success, warning, danger, info and idle
- bubble_text - bubble-text of item.
Elements
Headings
Texts and other
Paragraphs
You can create a new paragraph by leaving a blank line between lines of text.
Styling text
Main styles of text do you need below:
| Style | Syntax | Example | Output |
|---|---|---|---|
| Bold | ** ** | ** Bold text ** | Bold text |
| Italic | * * | * Italic text * | Italic text |
| Strikethrough | \~\~ \~\~ | \~\~ Mistaken text \~\~ | |
| Bold and nested italic | ** ** and _ _ | ** Bold and _ italic _ text ** | Bold and italic text |
| All bold and italic | *** *** | *** Totaly bold and italic *** | Totaly bold and italic |
Blockquote
How to use:
Code block
To format code or text into its own distinct block, use triple backticks
Place your code here
Links
How to use:
Footnotes
How to use:
Lists
Unordered list
Ordered list
Nested list
You can create nested list:
Tables
Standart table using like this:
Images
How to use:
Alerts
DocketWiki exists some custom alerts
Example:
Available types of notices:
- notice
- notice notice--success
- notice notice--warning
- notice notice--danger
- notice notice--info
Accordeon
If you want to hide some content into accordeon, you can place this code:
Icons
DocketWiki uses Feather Icon Pack for styling your sidebar-menu.
HTML tags
DocketWiki has full support of custom HTML-tags
You can place something like this:
All versions of docketwiki with dependencies
ext-mbstring Version *