Implementation code of PHP markdown document management tool

This article mainly shares with you the implementation code of PHP markdown document management tool, hoping to help everyone.

Main goals:

1. Can be edited by multiple people

2. Can be viewed in a browser

3. Have a foldable directory

4. Supports multi-level directories

5. Supports markdown

6. Fast and convenient

I have been engaged in PHP development since I started working as a major. Bao Dalaan has been relegated to writing interfaces on the server side. He has come into contact with several interface document management tools or systems. Here is a brief description:

1. showdoc, which is comprehensive and concise. User, rights management function, supports markdown, supports word export, has a variety of document templates, the directory supports two-level folding

2. confluence, powerful functions (rights management, email reminders, full-text search, Plug-in management, etc.), heavy, paid document management system

3. swagger, you need to write a lot of comments in the code to cooperate

4. readmine, rich in functions similar to confluence, its documents are saved in txt, changes can be traced, and full-text search is available, but writing documents is a bit painful, suitable for task/bug tracking management, etc.

5. gitbook, nodejs installation, supports markdown, supports npm plug-ins, the foldable directory tree on the left needs to install plug-ins, and you can also install search plug-ins. The directory is a separate markdown file. When I use it, I feel like it goes from md to HTML compilation is too slow (600+ documents, it takes more than 25 minutes to compile. If there are any plug-ins for incremental compilation or improving the compilation speed, please enlighten me

Solution:

1. It can be achieved by combining with git, and you can also use the permission management function of git

2. You need to compile markdown into an HTML file and deploy it to the intranet

3. Because I want to view it in a browser, I finally chose dtree.js, which has simple access, clean interface, and no dependencies (does not rely on jQuery)

4. This function uses the post-root order traversal algorithm of the tree to realize the reading of multi-level files (without using recursion, I am worried that I will get around myself when writing). It happens that dtree.js also supports multi-level directory folding

5. Here I finally chose the PHP compilation tool class officially produced by segmentfault (because they have already referenced and optimized many similar PHP classes, thank you~)

6. Quick If so, PHP takes about 2 seconds to compile more than 600 files, which is acceptable, and supports incremental compilation; if it is convenient, it is mainly reflected in the fact that the directory is automatically generated, and there is no need to write the directory separately

Problems encountered:

Incremental compilation

When we first judge whether an md file needs to be compiled into HTML, we compare the creation time and the last modification time of the md file. ,

But later I found that this method did not work for some copied and renamed files.
Finally, an intermediate file was used to record the time of the compiled file, and then followed by max( Compare creation time, last modification time) to determine whether compilation is required

Delete redundant files

During subsequent use, it was found that some md documents were deleted, but the final compiled files were not automatically deleted.

Therefore, during compilation, a difference set will be made between the md file and the final HTML file, and those redundant HTML files will be deleted.

Integrate dtree.js

First, dtree.js Certain json data is required to display the directory and interact with expand and collapse

Also, the font of dtree.js is relatively small, and its pictures, styles, and script files are all relative paths. I have modified the paths accordingly. , change it to an absolute path based on the current domain name, so that deployment to different domain names does not require modifying the hierarchical directory of the dtree.js code.

Assembly, beautifying HTML

assembly is written in advance Prepare the HTML code for the head, bottom, sidebar, etc. of HTML, then splice these contents into the compiled content, and finally put them into the corresponding folders for

beautification. This is mainly because of the official release of segmentfault. The compilation tool does not add styles to HTML elements (for example, table, code). I found the relevant css styles from github and beautified them.

Support multi-level directories

This also cost me a lot It was written with a lot of brain cells. When I was writing dynamic Huffman coding in college, I wrote a tree traversal.

I thought I was familiar with it, but who knew that it took me until 3 o'clock in the night to finally write it. This function is also considered the core One of the components.

Related recommendations:

Vuejs uses vue-markdown to render comment methods

##Preview markdown and modify the preview style in VSCode

A brief introduction to markdown editor

The above is the detailed content of Implementation code of PHP markdown document management tool. For more information, please follow other related articles on the PHP Chinese website!