Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pouyakary/pageman
HTML, Markdown and Legend mixer that Loves Jekyll and Kary Comments.
https://github.com/pouyakary/pageman
html jekyll kary-comments karyfoundation legend markup markup-language pageman
Last synced: 3 days ago
JSON representation
HTML, Markdown and Legend mixer that Loves Jekyll and Kary Comments.
- Host: GitHub
- URL: https://github.com/pouyakary/pageman
- Owner: pouyakary
- Created: 2016-06-28T00:10:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-12T16:46:03.000Z (about 2 years ago)
- Last Synced: 2024-09-24T14:04:08.541Z (3 days ago)
- Topics: html, jekyll, kary-comments, karyfoundation, legend, markup, markup-language, pageman
- Language: TypeScript
- Size: 104 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pageman
At Kary Foundation we use a very rich stack to build web. We use higher languages like TypeScript and Less. And templating via Jekyll. However when it comes to writing content it gets hard. We use Markdown for normal content and Legend for side commenting.
When it comes to having markdown, html and legend fixed together it really gets hard. Also HTML comments are horrible. As the foundation with most prestige on code management via commenting we need to have a C-family style of commenting so that we can bring Kary Comments into our document files.
In order to have all the said factors we developed Pageman. A base that lets you mixup all these languages with kary comments. This is a file made possible with pageman's preprocess:
## Installing
Simply install the pageman with npm
```
% npm install -g pageman
```
## Editor support
Kary Foundation provides a [Pageman Language Support Extension](https://marketplace.visualstudio.com/items?itemName=karyfoundation.pageman) for Visual Studio Code that you can use to highlight Pageman code.
## Usage
If you specify any file it will build just the said files
```
% pageman yourfile.kfml something.kfml
```
However you can also build the the whole directory by just typing
```
% pageman
```
And you can run a watching server with
```
% pageman -w
```
## Configuration
If you're using legend commentings in your website please make sure you have [these CSS](https://gist.github.com/pmkary/c5c13553ea36ba06df86acc4cc6217cf) classes defined.
