create-epic-remark
v0.2.5
Published
CLI tool to scaffold projects using epic-remark examples
Downloads
5
Maintainers
Readme
create-epic-remark
create-epic-remark
is a CLI tool for scaffolding examples from the epic-remark
repository. It is designed to make starting a new project with epic-remark
as easy as possible, so you can focus on writing content, and not on set up.
Features
- Quick setup for
epic-remark
projects. - Supports various examples tailored for different setups (Next.js and Nuxt.js so far)
- Lightweight and easy to use.
Installation
You don't need to install create-epic-remark
- it's designed to be used with npx
:
npx create-epic-remark
If you to prefer to install the package, you can do so with npm
or yarn
:
npm install -g create-epic-remark
npm exec create-epic-remark
yarn create epic-remark
Usage
When you run create-epic-remark
, the CLI will offer some prompts to help walk you through selecting and scaffolding an epic-remark
example.
npx create-epic-remark
However if you prefer to specify the example ahead of time, you can skip the prompts by passing the --example
flag:
npx create-epic-remark --example [example-name]
Available Examples
next-tailwind
: A Next.js setup with Tailwind CSS.nuxt-tailwind
: A Nuxt.js setup with Tailwind CSS.
Contributing
Contributions are welcome! Please see the contributing docs for more details.
Support
If you encounter any issues or have questions, please open an issue on the GitHub repository.
License
This project is licensed under the MIT License - see the license file for details.