Pugfolio

Create Your Portfolio using Pug Template Engine

Pug 템플릿 엔진을 사용하여 문서를 작성할 수 있게 하는 도구입니다.

쉽고 간결한 Pug로 문서를 작성해 보세요!

ChangeLog

See CHANGELOG

Demo

See example

Features

• Supporting Markdown
• Using Latex Syntax by Katex
• Code Highlighting by Prizm
• Save as PDF

Installation

• Install with npm:

npm install pugfolio -g

• Clone the repo:

git clone https://github.com/Astro36/Pugfolio.git

Usage

Command

• To run Pugfolio, use the following format:

pugfolio [config=pugfolio.json] [output=index.html]

Configuration

Property | Type | Default ----------- | ------- | -------- theme | String | required title | String | required subtitle | String | required author | String | required description | String | required writeAsPdf | Boolean | false files | Array | required

• Here’s an example pugfolio.json file:

{
  "theme": "skeleton",
  "title": "Pugfolio",
  "subtitle": "Create Your Portfolio using Pug Template Engine",
  "author": "Astro36",
  "description": "My Portfolio",
  "writeAsPdf": true,
  "files": ["about.pug", "portfolio.pug"]
}

You can find available themes on /themes directory.

Also, you can add custom theme on /themes directory.

License

Pugfolio
Copyright (C) 2017  Astro

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Pugfolio is licensed under the GPL 3.0.

KaTeX is licensed under a MIT License by Khan Academy.

Materialize is licensed under a MIT License by Dogfalo.

Prism.js is licensed under a MIT License by Lea Verou.

Skeleton is licensed under a MIT License by Dave Gamache.

Font Awesome is licensed under a SIL OFL 1.1 and MIT License by Font Awesome.

Material Design Icons is licensed under an Apache License 2.0 by Google.

Roboto is licensed under an Apache License 2.0 by Christian Robertson.

Spoqa Han Sans is licensed under a SIL OFL 1.1 by Spoqa.