Skip to content

CLI tool to auto-create content file from templates for Nuxt Content module

License

Notifications You must be signed in to change notification settings

mayashavin/create-content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-content

npm version npm download npm license

Create a content file automatically

A CLI tool to auto generate a content file (Markdown, CSV, YAML) based on available templates or customized templates.

Designed especially for working with Nuxtjs and Content module.

Install

npm i create-content

👩‍💻 How to run

create-content your-file-name

And then select from the options to create you file.

Features

  • Create a content file based on an existing templates:

    • Blog post in Markdown format (.md), with YAML formatter blocks to indicate some basic information about the post

      • title
      • description
      • image
      • tags
      • category
      • publishedAt

    Inspired by Nuxt Content's layout

    • Documentation page followed Theme Docs standards in Markdown format (.md), with YAML formatter blocks consisting the following fields:

      • title
      • description
      • position
      • version
      • category
      • fullscreen
      • menuTitle
      • subtitle
      • badge
    • Product info in Markdown format (.md), with YAML formatter blocks to indicate some basic information about the product:

      • title
      • description
      • image
      • price
      • tags
      • category
  • Create new content file manually with the following format:

    • .md - Markdown
    • .csv - CSV
    • .yaml - YAML

Coming soon

  1. Create and save new template per project (or globally)
  2. Create new content file based on the new template.

Contributing

  1. Clone this repository

  2. Install dependencies npm install

  3. Develop

  4. Test in local project using npm link

    • Run npm link
    • Go to the target project, run npm link create-content
    • You now can test if the tool works locally

Maintained by Maya Shavin