@markdownspace/cli

MarkdownSpace CLI Tool

Overview

MarkdownSpace CLI is a powerful and user-friendly tool designed for software engineers and content creators. It enables easy publishing of Markdown and MDX documents from a repository to Markdown Space, streamlining the process of content management and deployment.

Leveraging the robustness of TypeScript this tool offers an intuitive command-line interface for seamless integration into your development workflow.

Features

• Project-based API Key Management: Securely manage and use API keys that are specific to each Markdown Space project.
• Simple Publishing Workflow: Use npx markdownspace-publish to quickly publish your Markdown/MDX files to the designated project.
• Configurable Settings: Through markdownspace.config.js, customize the tool to your project's specific needs, including project ID/slug, file patterns for inclusion or exclusion, and draft upload options.
• Environment Variable Support: Configure your API credentials securely via a .env file with MDS_API_KEY.
• GitHub Actions Integration: Designed to work smoothly with CI/CD pipelines like GitHub Actions for automated publishing.

Getting Started

1. Install with npm i @markdownspace/cli
2. Retrieve api-key from https://markdown.space/ and add it as MDS_API_KEY to .env
3. Create a markdownspace.config.js file with the following command npx markdownspace init
4. Execute npx markdownspace publish

Contribution

Contributions are welcome! If you have suggestions or want to improve the tool, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.