README
¶
dodo-cli
dodo-cli enables you to use dodo-doc from the command line interface.
It can be easily set up with npm and provides various features useful for daily development such as upload, preview, and search.
Overview & Concept
dodo-doc is a powerful platform designed to host and manage your Markdown documents effortlessly. With dodo-doc, you can streamline your documentation process by deploying Markdown files with just a single command, thanks to its intuitive configuration setup.
- 🛠️ Developer-friendly: Seamlessly integrate dodo into your existing development workflows by simply uploading Markdown files. This ease of use makes it a perfect fit for developers looking to enhance their documentation processes.
- ⚡ Easy setup: Generate a configuration file template effortlessly using the
initcommand of the dodo-cli, simplifying the initial setup. - 🚀 CI/CD Integration: Simplify your CI/CD pipeline with dodo's single binary upload feature, allowing for automated and efficient document deployment.
- 🔒 Privacy Control: Keep your documents private with dodo's privacy settings, making it ideal for personal projects or sensitive information like diaries.
Documentation
- 📖 Read the documentation
- 📚 View the release note
Installation
Before you install this client, check the following prerequisites:
- Have an account on dodo-doc.
- Use a Linux or macOS operating system.
To install this client by npm, run the following command:
npm install -g @dodo-doc/cli
We also provides the binary version. You can download them from the release page.
Getting Started
Ready to dive in? Start by creating a dodo-doc account and hosting your first document. Follow the comprehensive guides below to set up the client and begin your journey with dodo.
Contributing
We welcome contributions to the dodo project! If you're interested in contributing, please read our contribution guidelines to get started.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories