Docsql

Overview:

docsQL is a CLI program that allows you to get an overview of your Jamstack Markdown files. It creates a searchable database by extracting the front-matter from each file and executing plugins. The front-matter becomes key-value pairs that can be queried, and the plugins provide additional functionality like counting headings. This tool is designed to help developers manage and analyze their Markdown files efficiently.

Features:

• Front-matter Extraction: The front-matter from Markdown files is extracted and converted into key-value pairs that can be queried.
• Searchable Database: The extracted front-matter is stored in a database, allowing users to perform queries based on specific keys.
• Built-in Plugins: docsQL comes with built-in plugins, such as “commonheadings.mjs,” which count the number of heading rows in the content for each file.
• Custom Plugins: Users can create custom plugins to extend the functionality of docsQL. These plugins can be included by specifying the folder containing the plugins when running the CLI.
• Integration with Git: Users can share their custom plugins with their team by zipping up the directory or creating a Git repo.

Installation:

To install docsQL, follow these steps:

1. Clone the git repository:

git clone <repository_url>

2. Navigate to the cloned directory:

cd docsQL

3. Install the required dependencies using npm:

npm install

Summary:

docsQL is a powerful tool for managing and analyzing Jamstack Markdown files. It provides a simple CLI interface for extracting and querying front-matter, creating a searchable database. With built-in and custom plugins, developers can extend the functionality of the tool to suit their specific needs. By providing an overview of the Markdown files and their content, docsQL helps developers efficiently manage their documentation projects.