https://github.com/picidaejs/picidaejs

🐦Picidae is a document generator which has gentle experience.
https://github.com/picidaejs/picidaejs

blog document generator hexo picidae pluggable ssr static-site-generator

Last synced: 1 day ago
JSON representation

🐦Picidae is a document generator which has gentle experience.

• Host: GitHub
• URL: https://github.com/picidaejs/picidaejs
• Owner: picidaejs
• License: mit
• Created: 2017-09-26T02:20:11.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-20T06:13:43.000Z (almost 6 years ago)
• Last Synced: 2024-11-11T21:04:50.192Z (2 days ago)
• Topics: blog, document, generator, hexo, picidae, pluggable, ssr, static-site-generator
• Language: JavaScript
• Homepage: https://picidaejs.github.io/picidaejs/
• Size: 3.26 MB
• Stars: 26
• Watchers: 6
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: Readme.md
  • Changelog: CHANGELOG.md
  • License: License

Awesome Lists containing this project

README

        
# Picidae

![](./logo/picidae-2x.png)

[![NPM version](https://img.shields.io/npm/v/picidae.svg?style=flat-square)](https://www.npmjs.com/package/picidae)

[![NPM Downloads](https://img.shields.io/npm/dm/picidae.svg?style=flat-square&maxAge=43200)](https://www.npmjs.com/package/picidae)

Picidae is a document generator which has gentle experience. :dash:  

As shown below

![](https://i.loli.net/2017/11/07/5a01c6630dc5f.jpg)

[Picidae Video](https://picidaejs.github.io/picidaejs/public)

## Why?

There are a lot of document generator now, why I choose Picidae?

|             | Picidae | Hexo | GitBook   |

| ----------- | ------- | ---- | --------  |

| SPA         | ✅      | ❌   | ❌(pjpx) |

| Transformer | ✅      | ❌   | ❌       |

Why I consider VuePress had supportted transformer partially?   

VuePress has markdown transformer by [markdown-it](https://github.com/markdown-it/markdown-it).

However, Picidae has more than it which includes **browser transformer**. the browser transformer could do lots of magic, eg. [react-render](https://github.com/picidaejs/picidae-transformer-react-render)

## Where use it

- [Myself own Blog](https://imcuttle.github.io/)

- [Baidu EUX](https://be-fe.github.io/picidae-theme-eux-blog/)

- [Picidae Document](https://picidaejs.github.io/picidaejs/)

## Starter

````bash

npm install picidae -g

picidae init [blog]

cd [blog]

# install Globally

picidae use picidae-theme-grass

# or install Locally

npm install picidae picidae-theme-grass --save

picidae start

open http://localhost:8989

# build the site for deploy

picidae build

# install Globally

picidae use picidae-commander-gh-pages

# or install Locally

npm install picidae-commander-gh-pages --save

# ```

# // append the configuration.

# commanders: [

#   '[email protected]:[username]/[username].github.io.git&branch=master&remote=origin'

# ]

# ```

picidae gh-pages # deploy the static assets to the github

````

## Theme

We can write customized Theme using React.  

[Default Theme](./theme)

## Commander

We can write customized Commander using `commander`.  

[Commander: New](commanders/gh-pages)

## Transformer

We can write customized Transformer which is divided into NodeTransformer & BrowserTransformer  

As shown below

** mdast -> remark transformer -> markdown -> markdown transfromer -> markdown -> html -> html transformer -> html -> browser transformer (converter) -> html-to-react **

- [picidae-transformer-style-loader](https://github.com/picidaejs/picidae-transformer-style-loader)  

- [picidae-transformer-react-render](https://github.com/picidaejs/picidae-transformer-react-render)  

- [picidae-transformer-file-syntax](https://github.com/picidaejs/picidae-transformer-file-syntax)  

- ...