generator-workshop

Yeoman generator for my workshops.

This generator provides the following features:

• VuePress as a static site generator.
• docs folder as a starter point to build your workshop.
• PWA ready.
• CC-BY-NC-SA-4.0 License to help protect your content.
• and more...

Project files

.
|--- docs
|    |--- .vuepress
|    |    |--- public
|    |    |    |--- android-chrome-192x192.png
|    |    |    |--- android-chrome-512x512.png
|    |    |    |--- apple-touch-icon.png
|    |    |    |--- browserconfig.xml
|    |    |    |--- favicon-16x16.png
|    |    |    |--- favicon-32x32.png
|    |    |    |--- favicon.ico
|    |    |    |--- mstile-150x150.png
|    |    |    |--- safari-pinned-tab.svg
|    |    |    |--- site.webmanifest
|    |    |--- config.js
|    |    |--- head.js
|    |    |--- override.styl
|    |    |--- style.styl
|    |    workshop
|    |    |--- README.md
|    |--- README.md
|--- .editorconfig
|--- .eslintignore
|--- .eslintrc.json
|--- .gitattributes
|--- .gitignore
|--- .npmrc
|--- .prettierrc
|--- CHANGELOG.md
|--- LICENSE
|--- package.json
|--- README.md

Installation

• Install Yeoman

$ npm install -g yo

• Install Generator

$ npm install -g @robertoachar/generator-workshop

Usage

• Creating a workshop

# Create a directory for your workshop
$ mkdir awesome-workshop

# Change into directory
$ cd awesome-workshop

# Generate a workshop
$ yo @robertoachar/workshop

• Running workshop

| Action | Usage | | ---------------------- | --------------- | | Start development mode | npm start | | Lint code | npm run lint | | Build for production | npm run build |

Development

Prerequisites

• Install Node.js
• Install npm
• Install Yeoman CLI

$ npm install -g yo

Clone the repo

$ git clone https://github.com/robertoachar/generator-workshop.git

Run generator

# Change into directory
$ cd generator-workshop

# Link generator
$ npm link

# Run generator
$ yo @robertoachar/workshop

Author

Roberto Achar

License

MIT