Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] English Grammar Revision #25

Merged
merged 2 commits into from
Oct 13, 2018
Merged

[WIP] English Grammar Revision #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e439b05
Initial commit
Oct 13, 2018
b78a275
Revise README.md
Oct 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
[![npm version](https://img.shields.io/npm/v/papogen.svg?style=for-the-badge)](https://badge.fury.io/js/papogen)
[![npm downloads](https://img.shields.io/npm/dm/papogen.svg?style=for-the-badge)](https://www.npmjs.com/package/papogen)

Let's *papoGen* now!
*papoGen* - Quickly generate your webpage without too much web development experience!
If you feel *papoGen* is good, hope you can give a `star`!
> Let's *papoGen*!

*papoGen* - Quickly generate webpages without any web development experience!

---
## About

*papoGen* is a static webpage generator. To generate a webpage, you won't need to have web development experience. Only need do is know the format of Markdown, JSON, and YAML. Then you can generate your own webpage by our pre-defined templates. Besides, if you want to design your own style of web page, you can also develop your own template by *papoGen* without having too much time. *papoGen* is developed by [*Toolbuddy*](https://github.com/toolbuddy). If you have like *papoGen* or our other tools, please give us a "star"! If you have any problem or suggestion, please feel free to contact us. We'd love to help you.
*papoGen* is a simple static webpage generator. You do not need any prior experience in web development to generate your webpage; the only prerequisite is a basic understanding of Markdown, JSON, and YAML. You can design your template or use any of our stock ones to generate pages of your own in little to no time at all. *papoGen* is developed by [*Toolbuddy*](https://github.com/toolbuddy). If you like *papoGen* or any of our other tools, please give us a star! If you have any problems or suggestions, please feel free to contact us or open an issue. We'd love to help you.

---
## Usage
Expand All @@ -22,9 +22,9 @@ If you feel *papoGen* is good, hope you can give a `star`!
```bash
» [sudo] npm install papogen -g
```
* Helping Manual
* Explain each parameter we support currently!
* See more in [here](https://github.com/toolbuddy/papoGen/blob/master/example/README.md).
* Manual
* Explains each parameters that we currently support in detail.
* See more in our example [README](https://github.com/toolbuddy/papoGen/blob/master/example/README.md).
2. **Generation**
```bash
» papogen -s test/ -o docs/ -t papoGen -m doc
Expand All @@ -34,15 +34,15 @@ If you feel *papoGen* is good, hope you can give a `star`!
## Description

* The [*papoGen* document (i.e., DEMO page)](https://toolbuddy.github.io/papoGen/) is generated by *papoGen*!
* Use JSON files under the folder `test/`
* Uses JSON files under the folder `test/`
* In `test/`, there are several categories of scripts, which are in their own directory.
* Besides, `README.md` in their directory explains the format we supported.
* Additionally, there is a `README.md` in each respective directory, containing explanation for the format that we support.
* View more:
* [doc page](https://toolbuddy.github.io/papoGen/)
* [resume page](https://toolbuddy.github.io/papoGen/resume)
* Generated by *script template*
* Use `-h` to list the last part of all supporting scripts.
* Use `papogen -c <script>/<format_1>/<format_2>/... -o <output>` to generate our template file.
* Use `-h` to list all supported scripts.
* Use `papogen -c <script>/<format_1>/<format_2>/... -o <output>` to generate using our template files.
* `<script>` is the blue one. (in `-h` output message)
* `<format>` is the grey one. (in `-h` output message)
* Version after `0.0.12` support several templates specified by using `/` to separate each format.
Expand All @@ -69,7 +69,7 @@ If you feel *papoGen* is good, hope you can give a `star`!
| `-o [--out]` | URL | The URL of the destination files' folder |
| `-t [--title]` | STRING | The title you want to show on webpage |
| `-g [--gen]` | `md` / `json` / `yaml` | The type of your source files |
| `-m [--model]` | `md_doc`* / `doc` / `resume` / `papogen`+ | The web template you want to generate |
| `-m [--model]` | `md_doc`* / `doc` / `resume` / `papogen`+ | The model template you want to generate with |
| `--theme` | `paper`# / `papogen`+ | The theme you want to render on your wabpage |
| `-h [--help]` | NONE | Show *papoGen* helping manual |

Expand All @@ -81,7 +81,7 @@ If you feel *papoGen* is good, hope you can give a `star`!

* Use Markdown format as configuration
* Different from the following format
* Generate from the file in Markdown directly
* Generate from Markdown files
* Support multiple Markdown files as input
* Supporting model: `md_doc`
* Example command
Expand All @@ -100,8 +100,8 @@ If you feel *papoGen* is good, hope you can give a `star`!
» papogen -s test/ -o docs/ -t papoGen -m doc
```

* After specifying the `src` directory, *PaperCSS* will fetch all the JSON files under `src`, and use the *filename* for each as "tag" in output.
* *papoGen* will base on the specified format to generate your content (see more detail below)
* After specifying the `src` directory, *PaperCSS* will fetch all the JSON files under `src` and use the *filename* for each file as "tag" in output. the
* *papoGen* will base on the input and generate your content (see more detail below)
* Currently support: `text` (see the source directory: `test/` as input, and destination directory: `docs/` as output)

### Format: YAML
Expand All @@ -116,8 +116,8 @@ If you feel *papoGen* is good, hope you can give a `star`!
» papogen -s test/ -o docs/ -t papoGen -m doc -g yaml
```

* After specifying the `src/` directory, *PaperCSS* will fetch all files in JSON format under `src/`, and use the *filename* for each as "tag" in output.
* *papoGen* will base on the specified format to generate content (see more detail below)
* After specifying the `src/` directory, *PaperCSS* will fetch all files in JSON format under `src/` and use the *filename* for each as "tag" in output.
* *papoGen* will base on the input and generate your content (see more detail below)
* Currently support: `text` (see the source directory: `test/` as input, and destination directory: `docs/` as output)

---
Expand Down Expand Up @@ -161,7 +161,7 @@ For more information about *papoGen*, you can refer our [wiki](https://github.co
---
## WIP

If you want to contribute *papoGen*, use `git clone` with `--recursive` to clone the entire project. (or using `git submodule update` to update your old version.)
If you want to contribute to *papoGen*, use `git clone` with `--recursive` to clone the entire project (or use `git submodule update` to update your old version).

* [papoGen.css](https://github.com/toolbuddy/papoGen.css)
* Our new web UI - *papoGen.css* is creating now!
Expand Down