Before Markdown, we used Word to edit project documents. Basically, only one person could edit the documents, and it was not very convenient to use multiple machines. If you accidentally forget to update, it will lead to failure to merge. There is no need to say much about Mardown, because the plain text format is very suitable for multiple people to edit documents. We promote Markdown in the project and put the Markdown documents in Svn, which perfectly solves the problem of continuous updating of documents, whether it is multiple people or multiple computers. Machine editing is no different from editing ordinary code. You can use a very mature method for text merging.
The accompanying problem (or inconvenience) is that if you want to view the Mardown documents in Svn, you need to update the local directory and use special software, which is somewhat inconvenient. The programmers are okay, other project participants are more troublesome, but we don't want to lose the advantages of SVN management. Fortunately, we have seen a good solution in the Topo project management software .
The first step is to configure the Svn library:
Then under the project, configure the code base directory of the project, which may be a branch or a directory:
In this way, you can browse the Markdown files in Svn. The great thing is that the pictures in Svn referenced in Mardown can be displayed correctly, which is very convenient:
In this way, we have converted most of the project documents to Markdown format, which is convenient for project members to modify and browse at any time.