Maintaining documentation is a challenging endeavor. Yes, there are VS_Code extensions for Markdown (.md) files. There are site generators for creating documentation. Yet many of these solutions are either time consuming, inflexible, or just all round hard to maintain. This is where SputDoc comes in to play. With our built in admin dashboard and handy CLI tools, you can take any existing codebase and turn it into a self documenting joy to use.
The quickest way to try out this code is to git clone this repository and then do yarn install then yarn test. That will run the jest tests for the backend code found in the file search API.
YES, you absolutely edit markdown files directly. But then you lose the job of seeing how things end up getting formatted. Little things may be different once they get production deployment. Improving this environment will make editing and mantaining docs more fun making you more intelligent, you team more happy, and you WILL bring more value to the end user.
This is where you can fire up with the web view of the file editor & file explorer. To run the editor, run cd editor and then yarn dev.
You can utilize these utilities in your backend to work with the different types of files that any project may have.
- getFiles.ts -> get all files in a directory, or filter them
- getFiles.test.ts