https://github.com/patarapolw/git-publisher

Similar to browsing in GitHub, but support custom markdown, YAML front matter, Pug and commenting
https://github.com/patarapolw/git-publisher

hyperpug pug showdownjs utterances

Last synced: 8 days ago
JSON representation

Similar to browsing in GitHub, but support custom markdown, YAML front matter, Pug and commenting

• Host: GitHub
• URL: https://github.com/patarapolw/git-publisher
• Owner: patarapolw
• License: mit
• Created: 2020-01-06T08:17:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T04:58:58.000Z (almost 2 years ago)
• Last Synced: 2024-10-18T09:13:42.132Z (2 months ago)
• Topics: hyperpug, pug, showdownjs, utterances
• Language: JavaScript
• Homepage:
• Size: 1.35 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-publisher

Similar to browsing on GitHub website, but these are supported.

- YAML front matter stripping

- Custom markdown, via Showdown.js extension

- Pug, with custom filters

- Custom page type, e.g., [Reveal-md](https://github.com/patarapolw/reveal-md), with `type: reveal` in YAML front matter

## Installation

Simply clone the repo, and create `.env` with

```dotenv

ROOT=

```

For example, you might add the repo as a submodule or repo in repo, for easy navigation.

## Running and building

Navigate to the repo, and run `yarn serve` or `yarn build`

To publish to GitHub, you might be interested in [gh-pages](https://www.npmjs.com/package/gh-pages)

- It is as simple as `gh-pages -d dist`

## Editing the config

You can edit the config in `git-publisher.(json|js|yaml)`, or `"gitPublisher"` field in `package.json`.

The defaults can be viewed at [/default-config.js](/default-config.js).

## Commenting

Commenting system is based on . To enable it, you will have to

- Make sure the repo is public, otherwise your readers will not be able to view the issues/comments.

- Make sure the utterances app is installed on the repo, otherwise users will not be able to post comments.

You can also use disqus, by providing `"disqus"` field in `git-publisher.(json|js|yaml)`.

## Real result

- 

## Plans

- YAML front matter usage, e.g. to search in a search box