https://github.com/gndx/astro-md-generator

Command-line interface (CLI) for adding new posts to your Astro project
https://github.com/gndx/astro-md-generator

astro astrojs cli markdown mdx

Last synced: 3 months ago
JSON representation

Command-line interface (CLI) for adding new posts to your Astro project

• Host: GitHub
• URL: https://github.com/gndx/astro-md-generator
• Owner: gndx
• License: mit
• Created: 2023-10-13T03:53:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-19T13:06:16.000Z (9 months ago)
• Last Synced: 2024-10-18T09:02:44.742Z (4 months ago)
• Topics: astro, astrojs, cli, markdown, mdx
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/astro-md-generator
• Size: 3.91 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.MD
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# astro-md-generator

This command-line interface (CLI) is designed for adding new posts to your Astro project. It analyzes the content in your `src/content/` folder to detect the structure of your Markdown/MDX files and enables you to generate new files that match your project's structure."



  



## Install

```npm

npm install -g astro-md-generator

```

## 📝 Adding New Posts (Usage)

To add a new post, run the following command in your project folder:

```bash

astro-md-generator

```

Follow the instructions and this will generate a new markdown file in the `src/content/`. Edit the file to add your post content.

## 🛠️ Add a command to your project

In your project built with Astro, add a new script in `package.json`

```scheme

"scripts": {

  ...

    "newpost": "astro-md-generator",

  },

```

## 💻 Contributing

Contributions to this project are welcome. If you find a bug or have a suggestion for improvement, please open an issue or submit a pull request.

## 📃 License

This project is licensed under the MIT License. See the `LICENSE` file for details.

## ☕ Support

If this project helped you learn something new, or if you're feeling particularly generous, you can buy me a coffee. It's greatly appreciated! 😊 [GitHub Sponsors](https://github.com/sponsors/gndx)