π cli - Create Beautiful Docs with Ease

π Description
The cli is a powerful tool that transforms your Markdown files into beautiful, searchable documentation websites. It gives you complete control over your landing page, making it easy to showcase your content in a clear and engaging way.
π Getting Started
Follow these steps to download and run the cli application from our Releases page.
π» System Requirements
Before you download the cli, ensure your system meets the following requirements:
- Operating System: Works on Windows, macOS, and Linux
- Storage Space: At least 100 MB free
- Permissions: You may need administrator permissions for installation
π₯ Download & Install
To get started, visit the Releases page to download the cli application.
- Click on the link above.
- A list of available versions will appear.
- Choose the version that fits your operating system.
- Click on the appropriate file to begin the download.
- Once the download completes, open the file to install the cli.
If you prefer, you can also download directly using this link:
Download cli
π§ How to Run cli
After installing the cli, you can run it with ease. Hereβs how:
- Open your Command Line Interface (CLI):
- On Windows, press
Win + R, type cmd, and hit Enter.
- On macOS, open
Terminal from Applications.
- On Linux, find
Terminal in your applications or use Ctrl + Alt + T.
- Navigate to your documents folder (or where you saved your Markdown files):
- Use the command
cd path/to/your/folder, replacing path/to/your/folder with the actual path.
- Run the cli command:
- Type
cli <your-markdown-file>. Replace <your-markdown-file> with the name of your Markdown file.
- Press
Enter.
- Your documentation site will generate in seconds!
π Features
- Markdown Support: Works seamlessly with Markdown syntax.
- Beautiful Themes: Choose from various themes to match your style.
- Search Functionality: Adds a search bar for quick content access.
- Custom Landing Pages: Fully customizable landing pages to present your documentation.
π Troubleshooting
If you encounter any issues while using cli, consider the following solutions:
- Missing Files: Ensure all required files are downloaded. Go back to the Releases page to double-check.
- Command Not Found: Make sure the CLI is installed correctly. If not, reinstall using the steps above.
- Permissions Issue: If you cannot run the cli, try running your Command Line Interface as an administrator.
π Topics Covered
The cli is great for users who work with various documentation techniques. Here are some key topics youβll find helpful:
- astro: Integrate with Astro for modern web development.
- markdown-to-html: Convert your Markdown files effortlessly.
- docsify: Build beautiful documentation sites on the fly.
π€ Support
If you have any questions or need further help, donβt hesitate to reach out. You can create issues in the GitHub repository, and the community will assist you.
π Contributing
We welcome contributions! If youβd like to help improve cli, please follow these steps:
- Fork the repository.
- Make your changes.
- Submit a pull request outlining the modifications you made.
Your contributions help make cli better for everyone!
π License
This project is licensed under the MIT License.
Thank you for choosing cli! Enjoy creating your stunning documentation.