Skip to content

Commit

Permalink
build(docs): generate files (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
luismayta committed Nov 9, 2024
1 parent 2d088c7 commit 5410fe8
Showing 1 changed file with 26 additions and 35 deletions.
61 changes: 26 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,27 @@
-->

[![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-plugin-template)](https://github.com/hadenlabs/zsh-plugin-template/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/zsh-plugin-template/lint-code)](https://github.com/hadenlabs/zsh-plugin-template/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/zsh-plugin-template/ci)](https://github.com/hadenlabs/zsh-plugin-template/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/zsh-plugin-template/test)](https://github.com/hadenlabs/zsh-plugin-template/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)
[![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-deno)](https://github.com/hadenlabs/zsh-deno/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/zsh-deno/lint-code)](https://github.com/hadenlabs/zsh-deno/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/zsh-deno/ci)](https://github.com/hadenlabs/zsh-deno/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/zsh-deno/test)](https://github.com/hadenlabs/zsh-deno/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)

# zsh-plugin-template
# zsh-deno

zsh-plugin-template for project

### Replace name project to New Project

```bash
agr 'zsh-plugin-template' 'new-project'
agr 'plugin-template' 'name_template'
agr 'PLUGIN_TEMPLATE' 'NAME_TEMPLATE'
agr 'ZshPluginTemplate' 'NameTemplate'
```
zsh-deno for project

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [zsh-plugin-name](https://github.com/hadenlabs/zsh-plugin-template)
- [zsh-deno](https://github.com/hadenlabs/zsh-deno)
- [gomplate](https://github.com/hairyhenderson/gomplate)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Installation

<!-- Space: Projects -->
<!-- Parent: ZshPluginTemplate -->
<!-- Title: Installation Oh-My-Zsh ZshPluginTemplate -->
<!-- Label: ZshPluginTemplate -->
<!-- Parent: ZshDeno -->
<!-- Title: Installation Oh-My-Zsh ZshDeno -->
<!-- Label: ZshDeno -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Label: Oh-My-Zsh -->
Expand All @@ -53,13 +44,13 @@ This is a list of plugins that need to be installed previously to enjoy all the
If you're using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), install this plugin by doing the following:

1. Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`
2. Clone the plugin `bash git clone https://github.com/hadenlabs/zsh-plugin-template`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-plugin-template )` to your list of plugins
2. Clone the plugin `bash git clone https://github.com/hadenlabs/zsh-deno`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-deno )` to your list of plugins
4. Open a new terminal and enjoy!
<!-- Space: Projects -->
<!-- Parent: ZshPluginTemplate -->
<!-- Title: Installation Antigen ZshPluginTemplate -->
<!-- Label: ZshPluginTemplate -->
<!-- Parent: ZshDeno -->
<!-- Title: Installation Antigen ZshDeno -->
<!-- Label: ZshDeno -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Label: Antigen -->
Expand All @@ -70,13 +61,13 @@ If you're using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), install this pl

If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:

1. Add `antigen bundle hadenlabs/zsh-plugin-template` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle hadenlabs/zsh-plugin-template` in a running zsh session.
1. Add `antigen bundle hadenlabs/zsh-deno` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle hadenlabs/zsh-deno` in a running zsh session.
3. Enjoy!
<!-- Space: Projects -->
<!-- Parent: ZshPluginTemplate -->
<!-- Title: Installation Antibody ZshPluginTemplate -->
<!-- Label: ZshPluginTemplate -->
<!-- Parent: ZshDeno -->
<!-- Title: Installation Antibody ZshDeno -->
<!-- Label: ZshDeno -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Include: docs/disclaimer.md -->
Expand All @@ -89,12 +80,12 @@ If you're using [Antibody](https://github.com/getantibody/antibody), install thi
1. Add :

```{.sourceCode .bash}
antibody bundle hadenlabs/zsh-plugin-template
antibody bundle hadenlabs/zsh-deno
```

to your `.zshrc` where you're adding your other plugins.

2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle hadenlabs/zsh-plugin-template` in a running zsh session.
2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle hadenlabs/zsh-deno` in a running zsh session.
3. Enjoy!

## Usage
Expand All @@ -108,17 +99,17 @@ task setup
## Examples

<!-- Space: Projects -->
<!-- Parent: ZshPluginTemplate -->
<!-- Title: Examples ZshPluginTemplate -->
<!-- Parent: ZshDeno -->
<!-- Title: Examples ZshDeno -->
<!-- Label: Examples -->
<!-- Include: ./../disclaimer.md -->
<!-- Include: ac:toc -->

### Common

<!-- Space: Projects -->
<!-- Parent: ZshPluginTemplate -->
<!-- Title: Functions ZshPluginTemplate -->
<!-- Parent: ZshDeno -->
<!-- Title: Functions ZshDeno -->
<!-- Label: Functions -->
<!-- Include: docs/disclaimer.md -->
<!-- Include: ac:toc -->
Expand All @@ -129,7 +120,7 @@ task setup

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/zsh-plugin-template/issues).
File a GitHub [issue](https://github.com/hadenlabs/zsh-deno/issues).

## Contributing

Expand Down Expand Up @@ -162,6 +153,6 @@ All other trademarks referenced herein are the property of their respective owne

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like zsh-plugin-template
## Don't forget to 🌟 Star 🌟 the repo if you like zsh-deno

[Your feedback is appreciated](https://github.com/hadenlabs/zsh-plugin-template/issues)
[Your feedback is appreciated](https://github.com/hadenlabs/zsh-deno/issues)

0 comments on commit 5410fe8

Please sign in to comment.