Skip to content

Commit

Permalink
fix: 🐛 fix spacement and break lines in template
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikael-R committed Sep 10, 2020
1 parent 937138d commit 9532ffd
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 9 deletions.
71 changes: 69 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
[![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Mikael-R/readme-template-generator)

[![NPM Version](https://img.shields.io/npm/v/readme-template-generator.svg?style=flat-square)](https://www.npmjs.com/package/readme-template-generator) [![NPM Monthly Downloads](https://img.shields.io/npm/dm/readme-template-generator.svg?style=flat-square)](https://npmjs.org/package/readme-template-generator)

[![License](https://img.shields.io/github/license/Mikael-R/readme-template-generator?style=flat-square)](LICENSE.md) [![Last Commit](https://img.shields.io/github/last-commit/Mikael-R/readme-template-generator?style=flat-square)](https://github.com/Mikael-R/readme-template-generator/commits/) ![Language Most Used](https://img.shields.io/github/languages/top/Mikael-R/readme-template-generator?style=flat-square) [![Implementations](https://img.shields.io/badge/%F0%9F%92%A1-implementations-8C8E93.svg?style=flat-square)](https://github.com/Mikael-R/readme-template-generator/issues) ![Repository Size](https://img.shields.io/github/repo-size/Mikael-R/readme-template-generator?style=flat-square)

[![Forks](https://img.shields.io/github/forks/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/network/members) [![Stars](https://img.shields.io/github/stars/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/stargazers) [![Watches](https://img.shields.io/github/watchers/Mikael-R/readme-template-generator?style=social)](https://github.com/Mikael-R/readme-template-generator/watchers)

[![Author Twitter](https://img.shields.io/twitter/follow/mikaelr16.svg?style=social)](https://twitter.com/mikaelr16)

<h1 id="title" align="center">Welcome to readme-template-generator 👋</h1>

<h4 align="center"> 🚧 readme-template-generator in development... 🚧</h4>
<h4 align="center">🚧 readme-template-generator in development... 🚧</h4>

> A readme template generator for your repositories
### 🔖 Table Of Contents

- 🤔 [How To Use](#how-to-use)
- 🚀 [Technologies](#technologies)
- 🌱 [Minimal Requirements](#minimal-requirements)
- 🎊 [Features](#features)
- 🎇 [Finished](#features-finished)
- 💡 [How To Contribute](#how-to-contribute)
- 🤗 [Contributors](#contributors)
- 👤 [Author](#author)
Expand All @@ -18,8 +32,59 @@

#### 💻 Desktop

If you use Linux, try run commands bellow as `sudo`

```sh
npm i -g readme-template-generator
```
or
```sh
yarn add -g readme-template-generator
```

#### 🌐 Online

```sh
npx readme-template-generator
```
or using yarn v2-beta
```sh
yarn dlx readme-template-generator
```

[Back To The Top](#title)

---

<h2 id="technologies">🚀 Technologies</h2>

- Gluegun
- Node
- Typescript
- EJS

[Back To The Top](#title)

---

<h2 id="minimal-requirements">🌱 Minimal Requirements</h2>

- NPM/Yarn LTS
- NodeJs

[Back To The Top](#title)

---

<h2 id="features">🎊 Features</h2>

<h4 id="features-finished">🎇 Finished</h4>

- [x] Finished template
- [x] Added emoji in questions
- [x] Integration with GitHub
- [x] Inform if need update

[Back To The Top](#title)

---
Expand Down Expand Up @@ -49,7 +114,7 @@

<p>

<a href="https://github.com/Mikael-R"><img width="60px" src="https://avatars1.githubusercontent.com/u/60241602?v=4" alt="Mikael-R"/></a>
<a href="https://github.com/Mikael-R"><img width="60" src="https://avatars1.githubusercontent.com/u/60241602?v=4"/>

</p>

Expand All @@ -61,7 +126,9 @@

🤓 **Mikael Rolim de Aquino <mikarg9@gmail.com>**

- Twitter: [@mikaelr16](https://twitter.com/mikaelr16)
- Github: [@Mikael-R](https://github.com/Mikael-R)
- LinkedIn: [@mikael-rolim-522aa21b1](https://linkedin.com/in/mikael-rolim-522aa21b1)

[Back To The Top](#title)

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "readme-template-generator",
"version": "0.9.5",
"version": "0.9.7",
"description": "CLI to help create readme file to document your project",
"private": false,
"repository": {
Expand Down
12 changes: 6 additions & 6 deletions src/templates/README.md.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

<h1 id="title" align="center">Welcome to <%= props.projectName %> 👋</h1>

<%- props.status ? `<h4 align="center"> 🚧 ${props.projectName} in ${props.status}... 🚧</h4>` : '' %>
<%- props.status ? `<h4 align="center">🚧 ${props.projectName} in ${props.status}... 🚧</h4>` : '' %>

<%= props.images.logo ? `![Logo](${props.images.logo})` : ''%>
<%- props.images.logo ? `<img align="center" src="${props.images.logo}" alt="logo">` : ''%>

<%- `> ${props.description}`%>

Expand Down Expand Up @@ -42,10 +42,10 @@
<% if (props.requirements.length) {%><%= '\n\n[Back To The Top](#title)\n\n---\n'%><% } %>

<% if (props.features.finished.length || props.features.pendent.length) {%><%- '<h2 id="features">🎊 Features</h2>\n\n'%><% } %>
<% if (props.features.finished.length) {%><%- '\n<h4> id="features-finished>🎇 Finished</h4>'%><% } %>
<% for (featureFinished of props.features.finished) {%><%= `- [x] ${featureFinished}\n`%><% } %>
<% if (props.features.pendent.length) {%><%- '\n<h4> id="features-pendent>🎆 Pendent</h4>'%><% } %>
<% for (featurePendent of props.features.pendent) {%><%= `- [ ] ${featurePendent}\n`%><% } %>
<% if (props.features.finished.length) {%><%- '\n<h4> id="features-finished>🎇 Finished</h4>\n'%><% } %>
<% for (featureFinished of props.features.finished) {%><%= `\n- [x] ${featureFinished}`%><% } %>
<% if (props.features.pendent.length) {%><%- '\n<h4> id="features-pendent>🎆 Pendent</h4>\n'%><% } %>
<% for (featurePendent of props.features.pendent) {%><%= `\n- [ ] ${featurePendent}`%><% } %>
<% if (props.features.finished.length || props.features.pendent.length) {%><%- '\n\n[Back To The Top](#title)\n\n---\n'%><% } %>

<% if (props.contribute.tutor.show) {%><%- `<h2 id="how-to-contribute">💡 How To Contribute</h2>\n\n
Expand Down

0 comments on commit 9532ffd

Please sign in to comment.