Use Sass/CSS + Pug + Node.js to generate beautiful static website.
GPL-3.0 License
Let's papoGen!
papoGen - Quickly generate webpages without any web development experience!
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. 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.
[sudo] npm install papogen -g
papogen -s test/ -o docs/ -t papoGen -m doc
test/
test/
, there are several categories of scripts, which are in their own directory.README.md
in each respective directory, containing explanation for the format that we support.-h
to list all supported scripts.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)
0.0.12
support several templates specified by using /
to separate each format.json/all
to get all currently supported copy to target the output directory.example/
to see more!Command Format
papogen -s [--src] <src_path> \
-o [--out] <out_path> \
-t [--title] <title> \
-g [--gen] <type> \
-m [--model] <name> \
--theme <theme> \
-h [--help]
Option | Value | Description |
---|---|---|
-s [--src] |
URL | The URL of the source files' folder |
-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 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 |
md_doc
*: The only model supports Markdown.paper
#: Default themepapogen
+: The only theme supports papogen
template. Notice that if you have already given the template as papogen
(i.e., -m papogen
), we will also set the theme as papogen
(i.e., --theme papogen
) automatically.md_doc
papogen -s test/md -o docs/md -g md -m md_doc -t Graph\ Theory
Use JSON format as configuration.
Example command: See more in here.
# Use directly (from source code)
node main.js -s test/ -o docs/ -t papoGen
# By installation
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 file as "tag" in output. the
papoGen will base on the input and generate your content (see more detail below)
text
(see the source directory: test/
as input, and destination directory: docs/
as output)Use YAML format as configuration.
Some formats are defined in JSON.
Example command:
# Use directly (from source code)
node main.js -s test/ -o docs/ -g yaml -t papoGen
# By installation
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 input and generate your content (see more detail below)
text
(see the source directory: test/
as input, and destination directory: docs/
as output)Digital Ocean Meetup
, 2018 ModernWeb
For more information about papoGen, you can refer our wiki in this repository.
See here.
Screenshot
Version | Table of Vontent | Main Page |
---|---|---|
v0.2.2 |
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
.